diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 00000000000..cc6e6cbeb7f --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,124 @@ +# Copyright 2021 Google LLC + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# https://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: A workflow for updating discovery artifacts +# Controls when the action will run. + +on: + schedule: + # * is a special character in YAML so you have to quote this string + # Run this Github Action every day at 7 AM UTC + - cron: '0 7 * * *' + +jobs: + build: + name: Update Discovery Artifacts PR + runs-on: ubuntu-latest + steps: + - name: Get current date + id: date + run: echo "::set-output name=current_date::$(date +'%Y-%m-%d')" + + - name: Check out master branch + uses: actions/checkout@v2 + with: + ref: refs/heads/master + + - name: Create branch + run: | + git checkout -b update-discovery-artifacts-${{ steps.date.outputs.current_date }} + + - name: Set up Python 3.9 + uses: actions/setup-python@v2 + with: + python-version: 3.9 + + - name: Install google-api-python-client + run: pip3 install -e . + + - name: Install script dependencies + run: pip3 install -r requirements.txt + working-directory: ./scripts + + # Apply a workaround to discovery.py to avoid DefaultCredentialsError + # which is raised when calling `build_from_document()` as a result of + # `google.auth.default()`. The workaround is to bypass the code block that + # attempts to load default credentials. + - name: Workaround to avoid DefaultCredentialsError in discovery.py + run: sed -i -e 's/if credentials is None/if False/g' googleapiclient/discovery.py + + - name: Run Change Summary + run: python3 updatediscoveryartifacts.py + working-directory: ./scripts + + - name: Commit changes + run: ./createcommits.sh + working-directory: ./scripts + + - name: Push changes + run: git push -f --set-upstream origin update-discovery-artifacts-${{ steps.date.outputs.current_date }} + + - name: Prepare summary for PR Body + id: pr_body + shell: bash + run: | + python3 buildprbody.py + output=$(cat temp/allapis.summary) + output="${output//'%'/'%25'}" + output="${output//$'\n'/'%0A'}" + output="${output//$'\r'/'%0D'}" + echo "::set-output name=change_summary::$output" + working-directory: ./scripts + + - name: Create PR + uses: actions/github-script@v4.0.2 + with: + github-token: ${{secrets.YOSHI_CODE_BOT_TOKEN}} + script: | + async function createPR () { + const { owner, repo } = context.repo + const branch = 'update-discovery-artifacts-${{ steps.date.outputs.current_date }}' + let prBody = `${{ steps.pr_body.outputs.change_summary }}` + const prTitle = 'chore: Update discovery artifacts' + const pullRequests = await github.pulls.list({ + owner: owner, + repo: repo, + head: `${owner}:${branch}`, + state: 'open' + }) + + if (pullRequests.data.length === 1) { + prNumber = pullRequests.data[0].number + await github.pulls.update({ + owner: owner, + repo: repo, + pull_number: prNumber, + title: prTitle, + body: prBody + }) + console.log('Updated PR') + } else { + const createPrResult = await github.pulls.create({ + owner: owner, + repo: repo, + base: 'master', + head: `${owner}:${branch}`, + title: prTitle, + body: prBody + }) + prNumber = createPrResult.data.number + console.log('Created PR') + } + } + createPR() diff --git a/.kokoro/release.sh b/.kokoro/release.sh index 9e91f247ad6..e10bd8921a7 100755 --- a/.kokoro/release.sh +++ b/.kokoro/release.sh @@ -26,7 +26,7 @@ python3 -m pip install --upgrade twine wheel setuptools export PYTHONUNBUFFERED=1 # Move into the package, build the distribution and upload. -TWINE_PASSWORD=$(cat "${KOKORO_KEYSTORE_DIR}/73713_google_cloud_pypi_password") +TWINE_PASSWORD=$(cat "${KOKORO_GFILE_DIR}/secret_manager/google-cloud-pypi-token") cd github/google-api-python-client python3 setup.py sdist bdist_wheel -twine upload --username gcloudpypi --password "${TWINE_PASSWORD}" dist/* +twine upload --username __token__ --password "${TWINE_PASSWORD}" dist/* diff --git a/.kokoro/release/common.cfg b/.kokoro/release/common.cfg index 3efc6f3bb57..2ea8e554f8d 100644 --- a/.kokoro/release/common.cfg +++ b/.kokoro/release/common.cfg @@ -23,18 +23,8 @@ env_vars: { value: "github/google-api-python-client/.kokoro/release.sh" } -# Fetch PyPI password -before_action { - fetch_keystore { - keystore_resource { - keystore_config_id: 73713 - keyname: "google_cloud_pypi_password" - } - } -} - # Tokens needed to report release status back to GitHub env_vars: { key: "SECRET_MANAGER_KEYS" - value: "releasetool-publish-reporter-app,releasetool-publish-reporter-googleapis-installation,releasetool-publish-reporter-pem" -} \ No newline at end of file + value: "releasetool-publish-reporter-app,releasetool-publish-reporter-googleapis-installation,releasetool-publish-reporter-pem,google-cloud-pypi-token" +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 4150d8855a5..dff7ecd3353 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## [2.3.0](https://www.github.com/googleapis/google-api-python-client/compare/v2.2.0...v2.3.0) (2021-04-28) + + +### Features + +* **apigee:** update the api ([3fd11cb](https://www.github.com/googleapis/google-api-python-client/commit/3fd11cbfa43679d14be7f09d9cb071d82d156ffa)) +* **dataflow:** update the api ([3fd11cb](https://www.github.com/googleapis/google-api-python-client/commit/3fd11cbfa43679d14be7f09d9cb071d82d156ffa)) +* **dialogflow:** update the api ([3fd11cb](https://www.github.com/googleapis/google-api-python-client/commit/3fd11cbfa43679d14be7f09d9cb071d82d156ffa)) +* **documentai:** update the api ([3fd11cb](https://www.github.com/googleapis/google-api-python-client/commit/3fd11cbfa43679d14be7f09d9cb071d82d156ffa)) +* **healthcare:** update the api ([3fd11cb](https://www.github.com/googleapis/google-api-python-client/commit/3fd11cbfa43679d14be7f09d9cb071d82d156ffa)) +* **osconfig:** update the api ([afea316](https://www.github.com/googleapis/google-api-python-client/commit/afea316d32842ecb9e7d626842d5926b0bf3e34f)) +* **sqladmin:** update the api ([cec4393](https://www.github.com/googleapis/google-api-python-client/commit/cec4393b8e37e229f68b2233a2041db062c2a335)) + ## [2.2.0](https://www.github.com/googleapis/google-api-python-client/compare/v2.1.0...v2.2.0) (2021-04-13) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000000..8b58ae9c01a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security Policy + +To report a security issue, please use [g.co/vulnz](https://g.co/vulnz). + +The Google Security Team will respond within 5 working days of your report on g.co/vulnz. + +We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue. diff --git a/describe.py b/describe.py index e53724e0494..1f846fd881c 100755 --- a/describe.py +++ b/describe.py @@ -28,7 +28,7 @@ import argparse import collections import json -import os +import pathlib import re import string import sys @@ -37,12 +37,15 @@ from googleapiclient.discovery import build from googleapiclient.discovery import build_from_document from googleapiclient.discovery import UnknownApiNameOrVersion -from googleapiclient.discovery_cache import get_static_doc from googleapiclient.http import build_http from googleapiclient.errors import HttpError import uritemplate +DISCOVERY_DOC_DIR = ( + pathlib.Path(__file__).parent.resolve() / "googleapiclient" / "discovery_cache" / "documents" +) + CSS = """ + +

AdMob API . accounts . adUnits

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

List the ad units under the specified AdMob account.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List the ad units under the specified AdMob account.
+
+Args:
+  parent: string, Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654 (required)
+  pageSize: integer, The maximum number of ad units to return. If unspecified or 0, at most 1000 ad units will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.
+  pageToken: string, The value returned by the last `ListAdUnitsResponse`; indicates that this is a continuation of a prior `ListAdUnits` call, and that the system should return the next page of data.
+  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 ad units list request.
+  "adUnits": [ # The resulting ad units for the requested account.
+    { # Describes an AdMob ad unit.
+      "adFormat": "A String", # AdFormat of the ad unit. Possible values are as follows: "BANNER" - Banner ad format. "BANNER_INTERSTITIAL" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad types are "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are "RICH_MEDIA" (interactive) and video where video can not be excluded.
+      "adTypes": [ # Ad media type supported by this ad unit. Possible values as follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
+        "A String",
+      ],
+      "adUnitId": "A String", # The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789
+      "appId": "A String", # The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789
+      "displayName": "A String", # The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.
+      "name": "A String", # Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789
+    },
+  ],
+  "nextPageToken": "A String", # If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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/admob_v1.accounts.apps.html b/docs/dyn/admob_v1.accounts.apps.html new file mode 100644 index 00000000000..b1f0f4db7e0 --- /dev/null +++ b/docs/dyn/admob_v1.accounts.apps.html @@ -0,0 +1,141 @@ + + + +

AdMob API . accounts . apps

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

List the apps under the specified AdMob account.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List the apps under the specified AdMob account.
+
+Args:
+  parent: string, Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654 (required)
+  pageSize: integer, The maximum number of apps to return. If unspecified or 0, at most 1000 apps will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.
+  pageToken: string, The value returned by the last `ListAppsResponse`; indicates that this is a continuation of a prior `ListApps` call, and that the system should return the next page of data.
+  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 apps list request.
+  "apps": [ # The resulting apps for the requested account.
+    { # Describes an AdMob app for a specific platform (For example: Android or iOS).
+      "appId": "A String", # The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789
+      "linkedAppInfo": { # Information from the app store if the app is linked to an app store. # Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store.
+        "appStoreId": "A String", # The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: "com.example.myapp". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example "105169111". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked.
+        "displayName": "A String", # Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store.
+      },
+      "manualAppInfo": { # Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store). # The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used.
+        "displayName": "A String", # The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.
+      },
+      "name": "A String", # Resource name for this app. Format is accounts/{publisher_id}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789
+      "platform": "A String", # Describes the platform of the app. Limited to "IOS" and "ANDROID".
+    },
+  ],
+  "nextPageToken": "A String", # If not empty, indicates that there may be more apps for the request; this value should be passed in a new `ListAppsRequest`.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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/admob_v1.accounts.html b/docs/dyn/admob_v1.accounts.html index 15a7a1c2621..c605d896c4a 100644 --- a/docs/dyn/admob_v1.accounts.html +++ b/docs/dyn/admob_v1.accounts.html @@ -74,6 +74,16 @@

AdMob API . accounts

Instance Methods

+

+ adUnits() +

+

Returns the adUnits Resource.

+ +

+ apps() +

+

Returns the apps Resource.

+

mediationReport()

diff --git a/docs/dyn/adsense_v2.accounts.adclients.adunits.html b/docs/dyn/adsense_v2.accounts.adclients.adunits.html new file mode 100644 index 00000000000..afc5553497c --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.adclients.adunits.html @@ -0,0 +1,238 @@ + + + +

AdSense Management API . accounts . adclients . adunits

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an ad unit from a specified account and ad client.

+

+ getAdcode(name, x__xgafv=None)

+

Gets the AdSense code for a given ad unit.

+

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

+

Lists all ad units under a specified account and ad client.

+

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

+

Lists all the custom channels available for an ad unit.

+

+ listLinkedCustomChannels_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets an ad unit from a specified account and ad client.
+
+Args:
+  name: string, Required. AdUnit to get information about. Format: accounts/{account_id}/adclient/{adclient_id}/adunit/{adunit_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
+  "contentAdsSettings": { # Settings specific to content ads (AFC). # Settings specific to content ads (AFC).
+    "size": "A String", # Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
+    "type": "A String", # Type of the ad unit.
+  },
+  "displayName": "A String", # Display name of the ad unit, as provided when the ad unit was created.
+  "name": "A String", # Resource name of the ad unit. Format: accounts/{account}/adclient/{adclient}/adunits/{adunit}
+  "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
+  "state": "A String", # State of the ad unit.
+}
+
+ +
+ getAdcode(name, x__xgafv=None) +
Gets the AdSense code for a given ad unit.
+
+Args:
+  name: string, Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of the AdSense code for a given ad unit.
+  "adCode": "A String", # Output only. The AdSense code snippet to add to the body of an HTML page.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all ad units under a specified account and ad client.
+
+Args:
+  parent: string, Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient} (required)
+  pageSize: integer, The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the adunit list rpc.
+  "adUnits": [ # The ad units returned in the list response.
+    { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
+      "contentAdsSettings": { # Settings specific to content ads (AFC). # Settings specific to content ads (AFC).
+        "size": "A String", # Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
+        "type": "A String", # Type of the ad unit.
+      },
+      "displayName": "A String", # Display name of the ad unit, as provided when the ad unit was created.
+      "name": "A String", # Resource name of the ad unit. Format: accounts/{account}/adclient/{adclient}/adunits/{adunit}
+      "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
+      "state": "A String", # State of the ad unit.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ listLinkedCustomChannels(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the custom channels available for an ad unit.
+
+Args:
+  parent: string, Required. The ad unit which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (required)
+  pageSize: integer, The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedCustomChannels` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the custom channels linked to an adunit list rpc.
+  "customChannels": [ # The custom channels returned in this list response.
+    { # Representation of a custom channel.
+      "displayName": "A String", # Display name of the custom channel.
+      "name": "A String", # Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
+      "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ listLinkedCustomChannels_next(previous_request, previous_response) +
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(previous_request, previous_response) +
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/adsense_v2.accounts.adclients.customchannels.html b/docs/dyn/adsense_v2.accounts.adclients.customchannels.html new file mode 100644 index 00000000000..95700eb87ed --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.adclients.customchannels.html @@ -0,0 +1,211 @@ + + + +

AdSense Management API . accounts . adclients . customchannels

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about the selected custom channel.

+

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

+

Lists all the custom channels available in an ad client.

+

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

+

Lists all the ad units available for a custom channel.

+

+ listLinkedAdUnits_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about the selected custom channel.
+
+Args:
+  name: string, Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a custom channel.
+  "displayName": "A String", # Display name of the custom channel.
+  "name": "A String", # Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
+  "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the custom channels available in an ad client.
+
+Args:
+  parent: string, Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient} (required)
+  pageSize: integer, The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the custom channel list rpc.
+  "customChannels": [ # The custom channels returned in this list response.
+    { # Representation of a custom channel.
+      "displayName": "A String", # Display name of the custom channel.
+      "name": "A String", # Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
+      "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ listLinkedAdUnits(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the ad units available for a custom channel.
+
+Args:
+  parent: string, Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
+  pageSize: integer, The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the ad units linked to a custom channel list rpc.
+  "adUnits": [ # The ad units returned in the list response.
+    { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
+      "contentAdsSettings": { # Settings specific to content ads (AFC). # Settings specific to content ads (AFC).
+        "size": "A String", # Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
+        "type": "A String", # Type of the ad unit.
+      },
+      "displayName": "A String", # Display name of the ad unit, as provided when the ad unit was created.
+      "name": "A String", # Resource name of the ad unit. Format: accounts/{account}/adclient/{adclient}/adunits/{adunit}
+      "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
+      "state": "A String", # State of the ad unit.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ listLinkedAdUnits_next(previous_request, previous_response) +
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(previous_request, previous_response) +
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/adsense_v2.accounts.adclients.html b/docs/dyn/adsense_v2.accounts.adclients.html new file mode 100644 index 00000000000..d99884478a3 --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.adclients.html @@ -0,0 +1,173 @@ + + + +

AdSense Management API . accounts . adclients

+

Instance Methods

+

+ adunits() +

+

Returns the adunits Resource.

+ +

+ customchannels() +

+

Returns the customchannels Resource.

+ +

+ urlchannels() +

+

Returns the urlchannels Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ getAdcode(name, x__xgafv=None)

+

Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).

+

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

+

Lists all the ad clients available in an account.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getAdcode(name, x__xgafv=None) +
Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
+
+Args:
+  name: string, Required. Name of the ad client for which to get the adcode. Format: accounts/{account}/adclients/{adclient} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of the AdSense code for a given ad client. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
+  "adCode": "A String", # Output only. The AdSense code snippet to add to the head of an HTML page.
+  "ampBody": "A String", # Output only. The AdSense code snippet to add to the body of an AMP page.
+  "ampHead": "A String", # Output only. The AdSense code snippet to add to the head of an AMP page.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the ad clients available in an account.
+
+Args:
+  parent: string, Required. The account which owns the collection of ad clients. Format: accounts/{account} (required)
+  pageSize: integer, The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the ad client list rpc.
+  "adClients": [ # The ad clients returned in this list response.
+    { # Representation of an ad client. An ad client represents a user's subscription with a specific AdSense product.
+      "name": "A String", # Resource name of the ad client. Format: accounts/{account}/adclient/{adclient}
+      "productCode": "A String", # Output only. Product code of the ad client. For example, "AFC" for AdSense for Content.
+      "reportingDimensionId": "A String", # Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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/adsense_v2.accounts.adclients.urlchannels.html b/docs/dyn/adsense_v2.accounts.adclients.urlchannels.html new file mode 100644 index 00000000000..4fefb9d2673 --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.adclients.urlchannels.html @@ -0,0 +1,134 @@ + + + +

AdSense Management API . accounts . adclients . urlchannels

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists active url channels.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists active url channels.
+
+Args:
+  parent: string, Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient} (required)
+  pageSize: integer, The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListUrlChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUrlChannels` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the url channels list rpc.
+  "nextPageToken": "A String", # Continuation token used to page through url channels. To retrieve the next page of the results, set the next request's "page_token" value to this.
+  "urlChannels": [ # The url channels returned in this list response.
+    { # Representation of a URL channel. URL channels allow you to track the performance of particular pages in your site; see [URL channels](https://support.google.com/adsense/answer/2923836) for more information.
+      "name": "A String", # Resource name of the URL channel. Format: accounts/{account}/adclient/{adclient}/urlchannels/{urlchannel}
+      "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `URL_CHANNEL_ID` reporting dimension.
+      "uriPattern": "A String", # URI pattern of the channel. Does not include "http://" or "https://". Example: www.example.com/home
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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/adsense_v2.accounts.alerts.html b/docs/dyn/adsense_v2.accounts.alerts.html new file mode 100644 index 00000000000..40e6b655913 --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.alerts.html @@ -0,0 +1,116 @@ + + + +

AdSense Management API . accounts . alerts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists all the alerts available in an account.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, languageCode=None, x__xgafv=None) +
Lists all the alerts available in an account.
+
+Args:
+  parent: string, Required. The account which owns the collection of alerts. Format: accounts/{account} (required)
+  languageCode: string, The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the alerts list rpc.
+  "alerts": [ # The alerts returned in this list response.
+    { # Representation of an alert.
+      "message": "A String", # Output only. The localized alert message. This may contain HTML markup, such as phrase elements or links.
+      "name": "A String", # Resource name of the alert. Format: accounts/{account}/alerts/{alert}
+      "severity": "A String", # Output only. Severity of this alert.
+      "type": "A String", # Output only. Type of alert. This identifies the broad type of this alert, and provides a stable machine-readable identifier that will not be translated. For example, "payment-hold".
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsense_v2.accounts.html b/docs/dyn/adsense_v2.accounts.html new file mode 100644 index 00000000000..7cdf565ce4b --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.html @@ -0,0 +1,254 @@ + + + +

AdSense Management API . accounts

+

Instance Methods

+

+ adclients() +

+

Returns the adclients Resource.

+ +

+ alerts() +

+

Returns the alerts Resource.

+ +

+ payments() +

+

Returns the payments Resource.

+ +

+ reports() +

+

Returns the reports Resource.

+ +

+ sites() +

+

Returns the sites Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about the selected AdSense account.

+

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

+

Lists all accounts available to this user.

+

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

+

Lists all accounts directly managed by the given AdSense account.

+

+ listChildAccounts_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about the selected AdSense account.
+
+Args:
+  name: string, Required. Account to get information about. Format: accounts/{account_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "displayName": "A String", # Output only. Display name of this account.
+  "name": "A String", # Resource name of the account. Format: accounts/pub-[0-9]+
+  "pendingTasks": [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification".
+    "A String",
+  ],
+  "premium": True or False, # Output only. Whether this account is premium.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+ +
+ list(pageSize=None, pageToken=None, x__xgafv=None) +
Lists all accounts available to this user.
+
+Args:
+  pageSize: integer, The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the account list rpc.
+  "accounts": [ # The accounts returned in this list response.
+    { # Representation of an account.
+      "createTime": "A String", # Output only. Creation time of the account.
+      "displayName": "A String", # Output only. Display name of this account.
+      "name": "A String", # Resource name of the account. Format: accounts/pub-[0-9]+
+      "pendingTasks": [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification".
+        "A String",
+      ],
+      "premium": True or False, # Output only. Whether this account is premium.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ listChildAccounts(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all accounts directly managed by the given AdSense account.
+
+Args:
+  parent: string, Required. The parent account, which owns the child accounts. Format: accounts/{account} (required)
+  pageSize: integer, The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the child account list rpc.
+  "accounts": [ # The accounts returned in this list response.
+    { # Representation of an account.
+      "createTime": "A String", # Output only. Creation time of the account.
+      "displayName": "A String", # Output only. Display name of this account.
+      "name": "A String", # Resource name of the account. Format: accounts/pub-[0-9]+
+      "pendingTasks": [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification".
+        "A String",
+      ],
+      "premium": True or False, # Output only. Whether this account is premium.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ listChildAccounts_next(previous_request, previous_response) +
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(previous_request, previous_response) +
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/adsense_v2.accounts.payments.html b/docs/dyn/adsense_v2.accounts.payments.html new file mode 100644 index 00000000000..06f5a023c86 --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.payments.html @@ -0,0 +1,118 @@ + + + +

AdSense Management API . accounts . payments

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, x__xgafv=None)

+

Lists all the payments available for an account.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, x__xgafv=None) +
Lists all the payments available for an account.
+
+Args:
+  parent: string, Required. The account which owns the collection of payments. Format: accounts/{account} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the payments list rpc.
+  "payments": [ # The payments returned in this list response.
+    { # Representation of an unpaid or paid payment. See [Payment timelines for AdSense](https://support.google.com/adsense/answer/7164703) for more information about payments.
+      "amount": "A String", # Output only. The amount of unpaid or paid earnings, as a formatted string, including the currency. E.g. "¥1,235 JPY", "$1,234.57", "£87.65".
+      "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Output only. For paid earnings, the date that the payment was credited. For unpaid earnings, this field is empty. Payment dates are always returned in the billing timezone (America/Los_Angeles).
+        "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.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "name": "A String", # Resource name of the payment. Format: accounts/{account}/payments/unpaid for unpaid (current) earnings. accounts/{account}/payments/yyyy-MM-dd for paid earnings.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsense_v2.accounts.reports.html b/docs/dyn/adsense_v2.accounts.reports.html new file mode 100644 index 00000000000..e3768025a42 --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.reports.html @@ -0,0 +1,398 @@ + + + +

AdSense Management API . accounts . reports

+

Instance Methods

+

+ saved() +

+

Returns the saved Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ generate(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

+

Generates an ad hoc report.

+

+ generateCsv(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

+

Generates a csv formatted ad hoc report.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None) +
Generates an ad hoc report.
+
+Args:
+  account: string, Required. The account which owns the collection of reports. Format: accounts/{account} (required)
+  currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+  dateRange: string, Date range of the report, if unset the range will be considered CUSTOM.
+    Allowed values
+      REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range.
+      CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.
+      TODAY - Current day.
+      YESTERDAY - Yesterday.
+      MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].
+      YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].
+      LAST_7_DAYS - Last 7 days, excluding current day.
+      LAST_30_DAYS - Last 30 days, excluding current day.
+  dimensions: string, Dimensions to base the report on. (repeated)
+    Allowed values
+      DIMENSION_UNSPECIFIED - Unspecified dimension.
+      DATE - Date dimension in YYYY-MM-DD format (e.g. "2010-02-10").
+      WEEK - Week dimension in YYYY-MM-DD format, representing the first day of each week (e.g. "2010-02-08"). The first day of the week is determined by the language_code specified in a report generation request (so e.g. this would be a Monday for "en-GB" or "es", but a Sunday for "en" or "fr-CA").
+      MONTH - Month dimension in YYYY-MM format (e.g. "2010-02").
+      ACCOUNT_NAME - Account name. The members of this dimension match the values from Account.display_name.
+      AD_CLIENT_ID - Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id.
+      PRODUCT_NAME - Localized product name (e.g. "AdSense for Content", "AdSense for Search").
+      PRODUCT_CODE - Product code (e.g. "AFC", "AFS"). The members of this dimension match the values from AdClient.product_code.
+      AD_UNIT_NAME - Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name.
+      AD_UNIT_ID - Unique ID of an ad unit (within which an ad was served). The members of this dimension match the values from AdUnit.reporting_dimension_id.
+      AD_UNIT_SIZE_NAME - Localized size of an ad unit (e.g. "728x90", "Responsive").
+      AD_UNIT_SIZE_CODE - The size code of an ad unit (e.g. "728x90", "responsive").
+      CUSTOM_CHANNEL_NAME - Custom channel name. The members of this dimension match the values from CustomChannel.display_name.
+      CUSTOM_CHANNEL_ID - Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.
+      OWNED_SITE_DOMAIN_NAME - Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain.
+      OWNED_SITE_ID - Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.
+      URL_CHANNEL_NAME - Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.
+      URL_CHANNEL_ID - Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.
+      BUYER_NETWORK_NAME - Name of an ad network that returned the winning ads for an ad request (e.g. "Google AdWords"). Note that unlike other "NAME" dimensions, the members of this dimensions are not localized.
+      BUYER_NETWORK_ID - Unique (opaque) ID of an ad network that returned the winning ads for an ad request.
+      BID_TYPE_NAME - Localized bid type name (e.g. "CPC bids", "CPM bids") for a served ad.
+      BID_TYPE_CODE - Type of a bid (e.g. "cpc", "cpm") for a served ad.
+      CREATIVE_SIZE_NAME - Localized creative size name (e.g. "728x90", "Dynamic") of a served ad.
+      CREATIVE_SIZE_CODE - Creative size code (e.g. "728x90", "dynamic") of a served ad.
+      DOMAIN_NAME - Localized name of a host on which an ad was served, after IDNA decoding (e.g. "www.google.com", "Web caches and other", "bücher.example").
+      DOMAIN_CODE - Name of a host on which an ad was served (e.g. "www.google.com", "webcaches", "xn--bcher-kva.example").
+      COUNTRY_NAME - Localized region name of a user viewing an ad (e.g. "United States", "France").
+      COUNTRY_CODE - CLDR region code of a user viewing an ad (e.g. "US", "FR").
+      PLATFORM_TYPE_NAME - Localized platform type name (e.g. "High-end mobile devices", "Desktop").
+      PLATFORM_TYPE_CODE - Platform type code (e.g. "HighEndMobile", "Desktop").
+      TARGETING_TYPE_NAME - Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network").
+      TARGETING_TYPE_CODE - Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork").
+      CONTENT_PLATFORM_NAME - Localized content platform name an ad request was made from (e.g. "AMP", "Web").
+      CONTENT_PLATFORM_CODE - Content platform code an ad request was made from (e.g. "AMP", "HTML").
+      AD_PLACEMENT_NAME - Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual").
+      AD_PLACEMENT_CODE - Ad placement code (e.g. "AD_UNIT", "ca-pub-123456:78910", "OTHER").
+      REQUESTED_AD_TYPE_NAME - Localized requested ad type name (e.g. "Display", "Link unit", "Other").
+      REQUESTED_AD_TYPE_CODE - Requested ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
+      SERVED_AD_TYPE_NAME - Localized served ad type name (e.g. "Display", "Link unit", "Other").
+      SERVED_AD_TYPE_CODE - Served ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
+      CUSTOM_SEARCH_STYLE_NAME - Custom search style name.
+      CUSTOM_SEARCH_STYLE_ID - Custom search style id.
+      DOMAIN_REGISTRANT - Domain registrants.
+      WEBSEARCH_QUERY_STRING - Query strings for web searches.
+  endDate_day: integer, 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.
+  endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  filters: string, Filters to be run on the report. (repeated)
+  languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
+  limit: integer, The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
+  metrics: string, Required. Reporting metrics. (repeated)
+    Allowed values
+      METRIC_UNSPECIFIED - Unspecified metric.
+      PAGE_VIEWS - Number of page views.
+      AD_REQUESTS - Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available.
+      MATCHED_AD_REQUESTS - Requests that returned at least one ad.
+      TOTAL_IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.
+      IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.
+      INDIVIDUAL_AD_IMPRESSIONS - Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads.
+      CLICKS - Number of times a user clicked on a standard content ad.
+      PAGE_VIEWS_SPAM_RATIO - Fraction of page views considered to be spam. Only available to premium accounts.
+      AD_REQUESTS_SPAM_RATIO - Fraction of ad requests considered to be spam. Only available to premium accounts.
+      MATCHED_AD_REQUESTS_SPAM_RATIO - Fraction of ad requests that returned ads considered to be spam. Only available to premium accounts.
+      IMPRESSIONS_SPAM_RATIO - Fraction of impressions considered to be spam. Only available to premium accounts.
+      INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO - Fraction of ad impressions considered to be spam. Only available to premium accounts.
+      CLICKS_SPAM_RATIO - Fraction of clicks considered to be spam. Only available to premium accounts.
+      AD_REQUESTS_COVERAGE - Ratio of requested ad units or queries to the number returned to the site.
+      PAGE_VIEWS_CTR - Ratio of individual page views that resulted in a click.
+      AD_REQUESTS_CTR - Ratio of ad requests that resulted in a click.
+      MATCHED_AD_REQUESTS_CTR - Ratio of clicks to matched requests.
+      IMPRESSIONS_CTR - Ratio of IMPRESSIONS that resulted in a click.
+      INDIVIDUAL_AD_IMPRESSIONS_CTR - Ratio of individual ad impressions that resulted in a click.
+      ACTIVE_VIEW_MEASURABILITY - Ratio of requests that were measurable for viewability.
+      ACTIVE_VIEW_VIEWABILITY - Ratio of requests that were viewable.
+      ACTIVE_VIEW_TIME - Mean time an ad was displayed on screen.
+      ESTIMATED_EARNINGS - Estimated earnings of the publisher. Note that earnings up to yesterday are accurate, more recent earnings are estimated due to the possibility of spam, or exchange rate fluctuations.
+      PAGE_VIEWS_RPM - Revenue per thousand page views. This is calculated by dividing the estimated revenue by the number of page views multiplied by 1000.
+      AD_REQUESTS_RPM - Revenue per thousand ad requests. This is calculated by dividing estimated revenue by the number of ad requests multiplied by 1000.
+      MATCHED_AD_REQUESTS_RPM - Revenue per thousand matched ad requests. This is calculated by dividing estimated revenue by the number of matched ad requests multiplied by 1000.
+      IMPRESSIONS_RPM - Revenue per thousand ad impressions. This is calculated by dividing estimated revenue by the number of ad impressions multiplied by 1000.
+      INDIVIDUAL_AD_IMPRESSIONS_RPM - Revenue per thousand individual ad impressions. This is calculated by dividing estimated revenue by the number of individual ad impressions multiplied by 1000.
+      COST_PER_CLICK - Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.
+      ADS_PER_IMPRESSION - Number of ad views per impression.
+      TOTAL_EARNINGS - Total earnings.
+      WEBSEARCH_RESULT_PAGES - Number of results pages.
+  orderBy: string, The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
+  reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
+    Allowed values
+      REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone.
+      ACCOUNT_TIME_ZONE - Use the account timezone in the report.
+      GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles).
+  startDate_day: integer, 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.
+  startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Result of a generated report.
+  "averages": { # Row representation. # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+    "cells": [ # Cells in the row.
+      { # Cell representation.
+        "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
+      },
+    ],
+  },
+  "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Required. End date of the range (inclusive).
+    "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.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "headers": [ # The header information; one for each dimension in the request, followed by one for each metric in the request.
+    { # The header information of the columns requested in the report.
+      "currencyCode": "A String", # The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY.
+      "name": "A String", # Required. Name of the header.
+      "type": "A String", # Required. Type of the header.
+    },
+  ],
+  "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request.
+    { # Row representation.
+      "cells": [ # Cells in the row.
+        { # Cell representation.
+          "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
+        },
+      ],
+    },
+  ],
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Required. Start date of the range (inclusive).
+    "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.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "totalMatchedRows": "A String", # The total number of rows matched by the report request.
+  "totals": { # Row representation. # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+    "cells": [ # Cells in the row.
+      { # Cell representation.
+        "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
+      },
+    ],
+  },
+  "warnings": [ # Any warnings associated with generation of the report. These warnings are always returned in English.
+    "A String",
+  ],
+}
+
+ +
+ generateCsv(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None) +
Generates a csv formatted ad hoc report.
+
+Args:
+  account: string, Required. The account which owns the collection of reports. Format: accounts/{account} (required)
+  currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+  dateRange: string, Date range of the report, if unset the range will be considered CUSTOM.
+    Allowed values
+      REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range.
+      CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.
+      TODAY - Current day.
+      YESTERDAY - Yesterday.
+      MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].
+      YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].
+      LAST_7_DAYS - Last 7 days, excluding current day.
+      LAST_30_DAYS - Last 30 days, excluding current day.
+  dimensions: string, Dimensions to base the report on. (repeated)
+    Allowed values
+      DIMENSION_UNSPECIFIED - Unspecified dimension.
+      DATE - Date dimension in YYYY-MM-DD format (e.g. "2010-02-10").
+      WEEK - Week dimension in YYYY-MM-DD format, representing the first day of each week (e.g. "2010-02-08"). The first day of the week is determined by the language_code specified in a report generation request (so e.g. this would be a Monday for "en-GB" or "es", but a Sunday for "en" or "fr-CA").
+      MONTH - Month dimension in YYYY-MM format (e.g. "2010-02").
+      ACCOUNT_NAME - Account name. The members of this dimension match the values from Account.display_name.
+      AD_CLIENT_ID - Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id.
+      PRODUCT_NAME - Localized product name (e.g. "AdSense for Content", "AdSense for Search").
+      PRODUCT_CODE - Product code (e.g. "AFC", "AFS"). The members of this dimension match the values from AdClient.product_code.
+      AD_UNIT_NAME - Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name.
+      AD_UNIT_ID - Unique ID of an ad unit (within which an ad was served). The members of this dimension match the values from AdUnit.reporting_dimension_id.
+      AD_UNIT_SIZE_NAME - Localized size of an ad unit (e.g. "728x90", "Responsive").
+      AD_UNIT_SIZE_CODE - The size code of an ad unit (e.g. "728x90", "responsive").
+      CUSTOM_CHANNEL_NAME - Custom channel name. The members of this dimension match the values from CustomChannel.display_name.
+      CUSTOM_CHANNEL_ID - Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.
+      OWNED_SITE_DOMAIN_NAME - Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain.
+      OWNED_SITE_ID - Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.
+      URL_CHANNEL_NAME - Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.
+      URL_CHANNEL_ID - Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.
+      BUYER_NETWORK_NAME - Name of an ad network that returned the winning ads for an ad request (e.g. "Google AdWords"). Note that unlike other "NAME" dimensions, the members of this dimensions are not localized.
+      BUYER_NETWORK_ID - Unique (opaque) ID of an ad network that returned the winning ads for an ad request.
+      BID_TYPE_NAME - Localized bid type name (e.g. "CPC bids", "CPM bids") for a served ad.
+      BID_TYPE_CODE - Type of a bid (e.g. "cpc", "cpm") for a served ad.
+      CREATIVE_SIZE_NAME - Localized creative size name (e.g. "728x90", "Dynamic") of a served ad.
+      CREATIVE_SIZE_CODE - Creative size code (e.g. "728x90", "dynamic") of a served ad.
+      DOMAIN_NAME - Localized name of a host on which an ad was served, after IDNA decoding (e.g. "www.google.com", "Web caches and other", "bücher.example").
+      DOMAIN_CODE - Name of a host on which an ad was served (e.g. "www.google.com", "webcaches", "xn--bcher-kva.example").
+      COUNTRY_NAME - Localized region name of a user viewing an ad (e.g. "United States", "France").
+      COUNTRY_CODE - CLDR region code of a user viewing an ad (e.g. "US", "FR").
+      PLATFORM_TYPE_NAME - Localized platform type name (e.g. "High-end mobile devices", "Desktop").
+      PLATFORM_TYPE_CODE - Platform type code (e.g. "HighEndMobile", "Desktop").
+      TARGETING_TYPE_NAME - Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network").
+      TARGETING_TYPE_CODE - Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork").
+      CONTENT_PLATFORM_NAME - Localized content platform name an ad request was made from (e.g. "AMP", "Web").
+      CONTENT_PLATFORM_CODE - Content platform code an ad request was made from (e.g. "AMP", "HTML").
+      AD_PLACEMENT_NAME - Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual").
+      AD_PLACEMENT_CODE - Ad placement code (e.g. "AD_UNIT", "ca-pub-123456:78910", "OTHER").
+      REQUESTED_AD_TYPE_NAME - Localized requested ad type name (e.g. "Display", "Link unit", "Other").
+      REQUESTED_AD_TYPE_CODE - Requested ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
+      SERVED_AD_TYPE_NAME - Localized served ad type name (e.g. "Display", "Link unit", "Other").
+      SERVED_AD_TYPE_CODE - Served ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
+      CUSTOM_SEARCH_STYLE_NAME - Custom search style name.
+      CUSTOM_SEARCH_STYLE_ID - Custom search style id.
+      DOMAIN_REGISTRANT - Domain registrants.
+      WEBSEARCH_QUERY_STRING - Query strings for web searches.
+  endDate_day: integer, 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.
+  endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  filters: string, Filters to be run on the report. (repeated)
+  languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
+  limit: integer, The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
+  metrics: string, Required. Reporting metrics. (repeated)
+    Allowed values
+      METRIC_UNSPECIFIED - Unspecified metric.
+      PAGE_VIEWS - Number of page views.
+      AD_REQUESTS - Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available.
+      MATCHED_AD_REQUESTS - Requests that returned at least one ad.
+      TOTAL_IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.
+      IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.
+      INDIVIDUAL_AD_IMPRESSIONS - Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads.
+      CLICKS - Number of times a user clicked on a standard content ad.
+      PAGE_VIEWS_SPAM_RATIO - Fraction of page views considered to be spam. Only available to premium accounts.
+      AD_REQUESTS_SPAM_RATIO - Fraction of ad requests considered to be spam. Only available to premium accounts.
+      MATCHED_AD_REQUESTS_SPAM_RATIO - Fraction of ad requests that returned ads considered to be spam. Only available to premium accounts.
+      IMPRESSIONS_SPAM_RATIO - Fraction of impressions considered to be spam. Only available to premium accounts.
+      INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO - Fraction of ad impressions considered to be spam. Only available to premium accounts.
+      CLICKS_SPAM_RATIO - Fraction of clicks considered to be spam. Only available to premium accounts.
+      AD_REQUESTS_COVERAGE - Ratio of requested ad units or queries to the number returned to the site.
+      PAGE_VIEWS_CTR - Ratio of individual page views that resulted in a click.
+      AD_REQUESTS_CTR - Ratio of ad requests that resulted in a click.
+      MATCHED_AD_REQUESTS_CTR - Ratio of clicks to matched requests.
+      IMPRESSIONS_CTR - Ratio of IMPRESSIONS that resulted in a click.
+      INDIVIDUAL_AD_IMPRESSIONS_CTR - Ratio of individual ad impressions that resulted in a click.
+      ACTIVE_VIEW_MEASURABILITY - Ratio of requests that were measurable for viewability.
+      ACTIVE_VIEW_VIEWABILITY - Ratio of requests that were viewable.
+      ACTIVE_VIEW_TIME - Mean time an ad was displayed on screen.
+      ESTIMATED_EARNINGS - Estimated earnings of the publisher. Note that earnings up to yesterday are accurate, more recent earnings are estimated due to the possibility of spam, or exchange rate fluctuations.
+      PAGE_VIEWS_RPM - Revenue per thousand page views. This is calculated by dividing the estimated revenue by the number of page views multiplied by 1000.
+      AD_REQUESTS_RPM - Revenue per thousand ad requests. This is calculated by dividing estimated revenue by the number of ad requests multiplied by 1000.
+      MATCHED_AD_REQUESTS_RPM - Revenue per thousand matched ad requests. This is calculated by dividing estimated revenue by the number of matched ad requests multiplied by 1000.
+      IMPRESSIONS_RPM - Revenue per thousand ad impressions. This is calculated by dividing estimated revenue by the number of ad impressions multiplied by 1000.
+      INDIVIDUAL_AD_IMPRESSIONS_RPM - Revenue per thousand individual ad impressions. This is calculated by dividing estimated revenue by the number of individual ad impressions multiplied by 1000.
+      COST_PER_CLICK - Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.
+      ADS_PER_IMPRESSION - Number of ad views per impression.
+      TOTAL_EARNINGS - Total earnings.
+      WEBSEARCH_RESULT_PAGES - Number of results pages.
+  orderBy: string, The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
+  reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
+    Allowed values
+      REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone.
+      ACCOUNT_TIME_ZONE - Use the account timezone in the report.
+      GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles).
+  startDate_day: integer, 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.
+  startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  "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.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsense_v2.accounts.reports.saved.html b/docs/dyn/adsense_v2.accounts.reports.saved.html new file mode 100644 index 00000000000..a5d09f5da9e --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.reports.saved.html @@ -0,0 +1,272 @@ + + + +

AdSense Management API . accounts . reports . saved

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ generate(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

+

Generates a saved report.

+

+ generateCsv(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

+

Generates a csv formatted saved report.

+

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

+

Lists saved reports.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None) +
Generates a saved report.
+
+Args:
+  name: string, Required. Name of the saved report. Format: accounts/{account}/reports/{report} (required)
+  currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+  dateRange: string, Date range of the report, if unset the range will be considered CUSTOM.
+    Allowed values
+      REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range.
+      CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.
+      TODAY - Current day.
+      YESTERDAY - Yesterday.
+      MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].
+      YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].
+      LAST_7_DAYS - Last 7 days, excluding current day.
+      LAST_30_DAYS - Last 30 days, excluding current day.
+  endDate_day: integer, 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.
+  endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
+  reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
+    Allowed values
+      REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone.
+      ACCOUNT_TIME_ZONE - Use the account timezone in the report.
+      GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles).
+  startDate_day: integer, 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.
+  startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Result of a generated report.
+  "averages": { # Row representation. # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+    "cells": [ # Cells in the row.
+      { # Cell representation.
+        "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
+      },
+    ],
+  },
+  "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Required. End date of the range (inclusive).
+    "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.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "headers": [ # The header information; one for each dimension in the request, followed by one for each metric in the request.
+    { # The header information of the columns requested in the report.
+      "currencyCode": "A String", # The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY.
+      "name": "A String", # Required. Name of the header.
+      "type": "A String", # Required. Type of the header.
+    },
+  ],
+  "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request.
+    { # Row representation.
+      "cells": [ # Cells in the row.
+        { # Cell representation.
+          "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
+        },
+      ],
+    },
+  ],
+  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Required. Start date of the range (inclusive).
+    "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.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "totalMatchedRows": "A String", # The total number of rows matched by the report request.
+  "totals": { # Row representation. # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+    "cells": [ # Cells in the row.
+      { # Cell representation.
+        "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
+      },
+    ],
+  },
+  "warnings": [ # Any warnings associated with generation of the report. These warnings are always returned in English.
+    "A String",
+  ],
+}
+
+ +
+ generateCsv(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None) +
Generates a csv formatted saved report.
+
+Args:
+  name: string, Required. Name of the saved report. Format: accounts/{account}/reports/{report} (required)
+  currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+  dateRange: string, Date range of the report, if unset the range will be considered CUSTOM.
+    Allowed values
+      REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range.
+      CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.
+      TODAY - Current day.
+      YESTERDAY - Yesterday.
+      MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].
+      YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].
+      LAST_7_DAYS - Last 7 days, excluding current day.
+      LAST_30_DAYS - Last 30 days, excluding current day.
+  endDate_day: integer, 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.
+  endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
+  reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
+    Allowed values
+      REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone.
+      ACCOUNT_TIME_ZONE - Use the account timezone in the report.
+      GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles).
+  startDate_day: integer, 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.
+  startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+  startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  "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.
+    },
+  ],
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists saved reports.
+
+Args:
+  parent: string, Required. The account which owns the collection of reports. Format: accounts/{account} (required)
+  pageSize: integer, The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListPayments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPayments` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the saved reports list rpc.
+  "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of the results, set the next request's "page_token" value to this.
+  "savedReports": [ # The reports returned in this list response.
+    { # Representation of a saved report.
+      "name": "A String", # Resource name of the report. Format: accounts/{account}/reports/{report}
+      "title": "A String", # Report title as specified by publisher.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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/adsense_v2.accounts.sites.html b/docs/dyn/adsense_v2.accounts.sites.html new file mode 100644 index 00000000000..a736fa3c289 --- /dev/null +++ b/docs/dyn/adsense_v2.accounts.sites.html @@ -0,0 +1,162 @@ + + + +

AdSense Management API . accounts . sites

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about the selected site.

+

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

+

Lists all the sites available in an account.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about the selected site.
+
+Args:
+  name: string, Required. Name of the site. Format: accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Site.
+  "autoAdsEnabled": True or False, # Whether auto ads is turned on for the site.
+  "domain": "A String", # Domain (or subdomain) of the site, e.g. "example.com" or "www.example.com". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension.
+  "name": "A String", # Resource name of a site. Format: accounts/{account}/sites/{site}
+  "reportingDimensionId": "A String", # Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension.
+  "state": "A String", # Output only. State of a site.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the sites available in an account.
+
+Args:
+  parent: string, Required. The account which owns the collection of sites. Format: accounts/{account} (required)
+  pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the sites list rpc.
+  "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
+  "sites": [ # The sites returned in this list response.
+    { # Representation of a Site.
+      "autoAdsEnabled": True or False, # Whether auto ads is turned on for the site.
+      "domain": "A String", # Domain (or subdomain) of the site, e.g. "example.com" or "www.example.com". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension.
+      "name": "A String", # Resource name of a site. Format: accounts/{account}/sites/{site}
+      "reportingDimensionId": "A String", # Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension.
+      "state": "A String", # Output only. State of a site.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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/adsense_v2.html b/docs/dyn/adsense_v2.html new file mode 100644 index 00000000000..c9de3966285 --- /dev/null +++ b/docs/dyn/adsense_v2.html @@ -0,0 +1,111 @@ + + + +

AdSense Management API

+

Instance Methods

+

+ accounts() +

+

Returns the accounts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index ccae6b09639..3d1f4aa5bb6 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -363,7 +363,7 @@

Method Details

"project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, "googleAdsLink": { # A link between an GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history. - "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. + "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. "createTime": "A String", # Output only. Time when this link was originally created. "customerId": "A String", # Immutable. Google Ads customer ID. @@ -425,7 +425,7 @@

Method Details

"project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' }, "googleAdsLink": { # A link between an GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history. - "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. + "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. "createTime": "A String", # Output only. Time when this link was originally created. "customerId": "A String", # Immutable. Google Ads customer ID. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html index a8b6a6ba0da..ebb7cf95e97 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.androidAppDataStreams.html @@ -77,9 +77,6 @@

Instance Methods

close()

Close httplib2 connections.

-

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

-

Creates an Android app stream with the specified location and attributes. Note that an Android app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).

delete(name, x__xgafv=None)

Deletes an android app stream on a property.

@@ -101,42 +98,6 @@

Method Details

Close httplib2 connections.
-
- create(parent, body=None, x__xgafv=None) -
Creates an Android app stream with the specified location and attributes. Note that an Android app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).
-
-Args:
-  parent: string, Required. The parent resource where this android app data stream will be created. Format: properties/123 (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # A resource message representing a Google Analytics Android app stream.
-  "createTime": "A String", # Output only. Time when this stream was originally created.
-  "displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
-  "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
-  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"
-  "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
-  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A resource message representing a Google Analytics Android app stream.
-  "createTime": "A String", # Output only. Time when this stream was originally created.
-  "displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
-  "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
-  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"
-  "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
-  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
-}
-
-
delete(name, x__xgafv=None)
Deletes an android app stream on a property.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html
index 1537a1556c0..ff7553cb5b9 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html
@@ -108,7 +108,7 @@ 

Method Details

The object takes the form of: { # A link between an GA4 property and a Google Ads account. - "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. + "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. "createTime": "A String", # Output only. Time when this link was originally created. "customerId": "A String", # Immutable. Google Ads customer ID. @@ -126,7 +126,7 @@

Method Details

An object of the form: { # A link between an GA4 property and a Google Ads account. - "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. + "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. "createTime": "A String", # Output only. Time when this link was originally created. "customerId": "A String", # Immutable. Google Ads customer ID. @@ -173,7 +173,7 @@

Method Details

{ # Response message for ListGoogleAdsLinks RPC. "googleAdsLinks": [ # List of GoogleAdsLinks. { # A link between an GA4 property and a Google Ads account. - "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. + "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. "createTime": "A String", # Output only. Time when this link was originally created. "customerId": "A String", # Immutable. Google Ads customer ID. @@ -210,7 +210,7 @@

Method Details

The object takes the form of: { # A link between an GA4 property and a Google Ads account. - "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. + "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. "createTime": "A String", # Output only. Time when this link was originally created. "customerId": "A String", # Immutable. Google Ads customer ID. @@ -229,7 +229,7 @@

Method Details

An object of the form: { # A link between an GA4 property and a Google Ads account. - "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true. + "adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account. "createTime": "A String", # Output only. Time when this link was originally created. "customerId": "A String", # Immutable. Google Ads customer ID. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html index 54bfb05c81d..d6c735946d5 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html @@ -77,9 +77,6 @@

Instance Methods

close()

Close httplib2 connections.

-

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

-

Creates an iOS app stream with the specified location and attributes. Note that an iOS app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).

delete(name, x__xgafv=None)

Deletes an iOS app stream on a property.

@@ -101,42 +98,6 @@

Method Details

Close httplib2 connections.
-
- create(parent, body=None, x__xgafv=None) -
Creates an iOS app stream with the specified location and attributes. Note that an iOS app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).
-
-Args:
-  parent: string, Required. The parent resource where this ios app data stream will be created. Format: properties/123 (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # A resource message representing a Google Analytics IOS app stream.
-  "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
-  "createTime": "A String", # Output only. Time when this stream was originally created.
-  "displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
-  "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
-  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"
-  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A resource message representing a Google Analytics IOS app stream.
-  "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
-  "createTime": "A String", # Output only. Time when this stream was originally created.
-  "displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
-  "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
-  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"
-  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
-}
-
-
delete(name, x__xgafv=None)
Deletes an iOS app stream on a property.
diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html
index eec6e5773f2..84e5d801c61 100644
--- a/docs/dyn/apigee_v1.organizations.environments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.html
@@ -474,6 +474,7 @@ 

Method Details

"host": "A String", # Host name of the target server. "name": "A String", # Target server revision name in the following format: `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` "port": 42, # Port number for the target server. + "protocol": "A String", # The protocol used by this target server. "tlsInfo": { # TLS settings for the target server. "ciphers": [ # List of ciphers that are granted access. "A String", diff --git a/docs/dyn/apigee_v1.organizations.environments.targetservers.html b/docs/dyn/apigee_v1.organizations.environments.targetservers.html index 40e27271f72..19d300b7ff1 100644 --- a/docs/dyn/apigee_v1.organizations.environments.targetservers.html +++ b/docs/dyn/apigee_v1.organizations.environments.targetservers.html @@ -110,6 +110,7 @@

Method Details

"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. "name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. + "protocol": "A String", # Immutable. The protocol used by this TargetServer. "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", @@ -145,6 +146,7 @@

Method Details

"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. "name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. + "protocol": "A String", # Immutable. The protocol used by this TargetServer. "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", @@ -186,6 +188,7 @@

Method Details

"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. "name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. + "protocol": "A String", # Immutable. The protocol used by this TargetServer. "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", @@ -227,6 +230,7 @@

Method Details

"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. "name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. + "protocol": "A String", # Immutable. The protocol used by this TargetServer. "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", @@ -263,6 +267,7 @@

Method Details

"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. "name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. + "protocol": "A String", # Immutable. The protocol used by this TargetServer. "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", @@ -297,6 +302,7 @@

Method Details

"isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. "name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. + "protocol": "A String", # Immutable. The protocol used by this TargetServer. "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", diff --git a/docs/dyn/apigee_v1.organizations.instances.html b/docs/dyn/apigee_v1.organizations.instances.html index 3e062ba7571..15186ac7cf2 100644 --- a/docs/dyn/apigee_v1.organizations.instances.html +++ b/docs/dyn/apigee_v1.organizations.instances.html @@ -93,7 +93,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, environments=None, x__xgafv=None)

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

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.

delete(name, x__xgafv=None)

@@ -117,7 +117,7 @@

Method Details

- create(parent, body=None, environments=None, x__xgafv=None) + create(parent, body=None, x__xgafv=None)
Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.
 
 Args:
@@ -139,7 +139,6 @@ 

Method Details

"state": "A String", # Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. } - environments: string, Optional. List of environments that will be attached to the instance during creation. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apigee_v1.projects.html b/docs/dyn/apigee_v1.projects.html index 998dc12d67d..4de4c01ec1a 100644 --- a/docs/dyn/apigee_v1.projects.html +++ b/docs/dyn/apigee_v1.projects.html @@ -98,7 +98,7 @@

Method Details

{ # Request for ProvisionOrganization. "analyticsRegion": "A String", # Primary Cloud Platform region for analytics data storage. For valid values, see [Create an organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). Defaults to `us-west1`. "authorizedNetwork": "A String", # Name of the customer project's VPC network. If provided, the network needs to be peered through Service Networking. If none is provided, the organization will have access only to the public internet. - "runtimeLocation": "A String", # Cloud Platform location for the runtime instance. Defaults to `us-west1-a`. + "runtimeLocation": "A String", # Cloud Platform location for the runtime instance. Defaults to zone `us-west1-a`. If a region is provided, `EVAL` organizations will use the region for automatically selecting a zone for the runtime instance. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/apikeys_v2.html b/docs/dyn/apikeys_v2.html new file mode 100644 index 00000000000..9178a8883fb --- /dev/null +++ b/docs/dyn/apikeys_v2.html @@ -0,0 +1,121 @@ + + + +

API Keys API

+

Instance Methods

+

+ keys() +

+

Returns the keys Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/apikeys_v2.keys.html b/docs/dyn/apikeys_v2.keys.html new file mode 100644 index 00000000000..8f1dc903fd8 --- /dev/null +++ b/docs/dyn/apikeys_v2.keys.html @@ -0,0 +1,109 @@ + + + +

API Keys API . keys

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ lookupKey(keyString=None, x__xgafv=None)

+

Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ lookupKey(keyString=None, x__xgafv=None) +
Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.
+
+Args:
+  keyString: string, Required. Finds the project that owns the key string value.
+  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 `LookupKey` method.
+  "name": "A String", # The resource name of the API key. If the API key has been purged, resource name is empty.
+  "parent": "A String", # The project that owns the key with the value specified in the request.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/apikeys_v2.operations.html b/docs/dyn/apikeys_v2.operations.html new file mode 100644 index 00000000000..cf713350291 --- /dev/null +++ b/docs/dyn/apikeys_v2.operations.html @@ -0,0 +1,124 @@ + + + +

API Keys API . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/apikeys_v2.projects.html b/docs/dyn/apikeys_v2.projects.html new file mode 100644 index 00000000000..12e57e14349 --- /dev/null +++ b/docs/dyn/apikeys_v2.projects.html @@ -0,0 +1,91 @@ + + + +

API Keys API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/apikeys_v2.projects.locations.html b/docs/dyn/apikeys_v2.projects.locations.html new file mode 100644 index 00000000000..91ca846e4f2 --- /dev/null +++ b/docs/dyn/apikeys_v2.projects.locations.html @@ -0,0 +1,91 @@ + + + +

API Keys API . projects . locations

+

Instance Methods

+

+ keys() +

+

Returns the keys Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/apikeys_v2.projects.locations.keys.html b/docs/dyn/apikeys_v2.projects.locations.keys.html new file mode 100644 index 00000000000..32d7fc7670f --- /dev/null +++ b/docs/dyn/apikeys_v2.projects.locations.keys.html @@ -0,0 +1,557 @@ + + + +

API Keys API . projects . locations . keys

+

Instance Methods

+

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

+

Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

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

+

Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

+ get(name, x__xgafv=None)

+

Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

+ getKeyString(name, x__xgafv=None)

+

Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

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

+

Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

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

+

Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

Method Details

+
+ clone(name, body=None, x__xgafv=None) +
Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  name: string, Required. The resource name of the API key to be cloned in the same project. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `CloneKey` method.
+  "keyId": "A String", # User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.
+}
+
+  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.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, keyId=None, x__xgafv=None) +
Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  parent: string, Required. The project in which the API key is created. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The representation of a key managed by the API Keys API.
+  "createTime": "A String", # Output only. A timestamp identifying the time this key was originally created.
+  "deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
+  "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters.
+  "etag": "A String", # Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.
+  "name": "A String", # Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.
+  "restrictions": { # Describes the restrictions on the key. # Key restrictions.
+    "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key.
+      "allowedApplications": [ # A list of Android applications that are allowed to make API calls with this key.
+        { # Identifier of an Android application for key use.
+          "packageName": "A String", # The package name of the application.
+          "sha1Fingerprint": "A String", # The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
+        },
+      ],
+    },
+    "apiTargets": [ # A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
+      { # A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.
+        "methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*`
+          "A String",
+        ],
+        "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.
+      },
+    ],
+    "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key.
+      "allowedReferrers": [ # A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
+        "A String",
+      ],
+    },
+    "iosKeyRestrictions": { # The iOS apps that are allowed to use the key. # The iOS apps that are allowed to use the key.
+      "allowedBundleIds": [ # A list of bundle IDs that are allowed when making API calls with this key.
+        "A String",
+      ],
+    },
+    "serverKeyRestrictions": { # The IP addresses of callers that are allowed to use the key. # The IP addresses of callers that are allowed to use the key.
+      "allowedIps": [ # A list of the caller IP addresses that are allowed to make API calls with this key.
+        "A String",
+      ],
+    },
+  },
+  "uid": "A String", # Output only. Unique id in UUID4 format.
+  "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated.
+}
+
+  keyId: string, User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.
+  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, etag=None, x__xgafv=None) +
Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  name: string, Required. The resource name of the API key to be deleted. (required)
+  etag: string, Optional. The etag known to the client for the expected state of the key. This is to be used for optimistic concurrency.
+  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.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  name: string, Required. The resource name of the API key to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The representation of a key managed by the API Keys API.
+  "createTime": "A String", # Output only. A timestamp identifying the time this key was originally created.
+  "deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
+  "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters.
+  "etag": "A String", # Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.
+  "name": "A String", # Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.
+  "restrictions": { # Describes the restrictions on the key. # Key restrictions.
+    "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key.
+      "allowedApplications": [ # A list of Android applications that are allowed to make API calls with this key.
+        { # Identifier of an Android application for key use.
+          "packageName": "A String", # The package name of the application.
+          "sha1Fingerprint": "A String", # The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
+        },
+      ],
+    },
+    "apiTargets": [ # A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
+      { # A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.
+        "methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*`
+          "A String",
+        ],
+        "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.
+      },
+    ],
+    "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key.
+      "allowedReferrers": [ # A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
+        "A String",
+      ],
+    },
+    "iosKeyRestrictions": { # The iOS apps that are allowed to use the key. # The iOS apps that are allowed to use the key.
+      "allowedBundleIds": [ # A list of bundle IDs that are allowed when making API calls with this key.
+        "A String",
+      ],
+    },
+    "serverKeyRestrictions": { # The IP addresses of callers that are allowed to use the key. # The IP addresses of callers that are allowed to use the key.
+      "allowedIps": [ # A list of the caller IP addresses that are allowed to make API calls with this key.
+        "A String",
+      ],
+    },
+  },
+  "uid": "A String", # Output only. Unique id in UUID4 format.
+  "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated.
+}
+
+ +
+ getKeyString(name, x__xgafv=None) +
Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  name: string, Required. The resource name of the API key to be retrieved. (required)
+  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 `GetKeyString` method.
+  "keyString": "A String", # An encrypted and signed value of the key.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  parent: string, Required. Lists all API keys associated with this project. (required)
+  filter: string, Optional. Only list keys that conform to the specified filter. The allowed filter strings are `state:ACTIVE` and `state:DELETED`. By default, ListKeys returns only active keys.
+  pageSize: integer, Optional. Specifies the maximum number of results to be returned at a time.
+  pageToken: string, Optional. Requests a specific page of results.
+  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 `ListKeys` method.
+  "keys": [ # A list of API keys.
+    { # The representation of a key managed by the API Keys API.
+      "createTime": "A String", # Output only. A timestamp identifying the time this key was originally created.
+      "deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
+      "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters.
+      "etag": "A String", # Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.
+      "name": "A String", # Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.
+      "restrictions": { # Describes the restrictions on the key. # Key restrictions.
+        "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key.
+          "allowedApplications": [ # A list of Android applications that are allowed to make API calls with this key.
+            { # Identifier of an Android application for key use.
+              "packageName": "A String", # The package name of the application.
+              "sha1Fingerprint": "A String", # The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
+            },
+          ],
+        },
+        "apiTargets": [ # A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
+          { # A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.
+            "methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*`
+              "A String",
+            ],
+            "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.
+          },
+        ],
+        "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key.
+          "allowedReferrers": [ # A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
+            "A String",
+          ],
+        },
+        "iosKeyRestrictions": { # The iOS apps that are allowed to use the key. # The iOS apps that are allowed to use the key.
+          "allowedBundleIds": [ # A list of bundle IDs that are allowed when making API calls with this key.
+            "A String",
+          ],
+        },
+        "serverKeyRestrictions": { # The IP addresses of callers that are allowed to use the key. # The IP addresses of callers that are allowed to use the key.
+          "allowedIps": [ # A list of the caller IP addresses that are allowed to make API calls with this key.
+            "A String",
+          ],
+        },
+      },
+      "uid": "A String", # Output only. Unique id in UUID4 format.
+      "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # The pagination token for the next page of results.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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) +
Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  name: string, Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The representation of a key managed by the API Keys API.
+  "createTime": "A String", # Output only. A timestamp identifying the time this key was originally created.
+  "deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
+  "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters.
+  "etag": "A String", # Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.
+  "name": "A String", # Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.
+  "restrictions": { # Describes the restrictions on the key. # Key restrictions.
+    "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key.
+      "allowedApplications": [ # A list of Android applications that are allowed to make API calls with this key.
+        { # Identifier of an Android application for key use.
+          "packageName": "A String", # The package name of the application.
+          "sha1Fingerprint": "A String", # The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
+        },
+      ],
+    },
+    "apiTargets": [ # A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
+      { # A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.
+        "methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*`
+          "A String",
+        ],
+        "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.
+      },
+    ],
+    "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key.
+      "allowedReferrers": [ # A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
+        "A String",
+      ],
+    },
+    "iosKeyRestrictions": { # The iOS apps that are allowed to use the key. # The iOS apps that are allowed to use the key.
+      "allowedBundleIds": [ # A list of bundle IDs that are allowed when making API calls with this key.
+        "A String",
+      ],
+    },
+    "serverKeyRestrictions": { # The IP addresses of callers that are allowed to use the key. # The IP addresses of callers that are allowed to use the key.
+      "allowedIps": [ # A list of the caller IP addresses that are allowed to make API calls with this key.
+        "A String",
+      ],
+    },
+  },
+  "uid": "A String", # Output only. Unique id in UUID4 format.
+  "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated.
+}
+
+  updateMask: string, The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: `display_name` and `restrictions`. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields.
+  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.
+  },
+}
+
+ +
+ undelete(name, body=None, x__xgafv=None) +
Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+
+Args:
+  name: string, Required. The resource name of the API key to be undeleted. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `UndeleteKey` method.
+}
+
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/area120tables_v1alpha1.tables.html b/docs/dyn/area120tables_v1alpha1.tables.html index ec2b232d396..e37aa597081 100644 --- a/docs/dyn/area120tables_v1alpha1.tables.html +++ b/docs/dyn/area120tables_v1alpha1.tables.html @@ -86,7 +86,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets a table. Returns NOT_FOUND if the table does not exist.

- list(pageSize=None, pageToken=None, x__xgafv=None)

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

Lists tables for the user.

list_next(previous_request, previous_response)

@@ -126,6 +126,7 @@

Method Details

"relationshipColumn": "A String", # The name of the relationship column associated with the lookup. "relationshipColumnId": "A String", # The id of the relationship column. }, + "multipleValuesDisallowed": True or False, # Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible. "name": "A String", # column name "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship. "linkedTable": "A String", # The name of the table this relationship is linked to. @@ -146,10 +147,11 @@

Method Details

- list(pageSize=None, pageToken=None, x__xgafv=None) + list(orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists tables for the user.
 
 Args:
+  orderBy: string, Optional. Sorting order for the list of tables on createTime/updateTime.
   pageSize: integer, The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.
   pageToken: string, A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -178,6 +180,7 @@ 

Method Details

"relationshipColumn": "A String", # The name of the relationship column associated with the lookup. "relationshipColumnId": "A String", # The id of the relationship column. }, + "multipleValuesDisallowed": True or False, # Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible. "name": "A String", # column name "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship. "linkedTable": "A String", # The name of the table this relationship is linked to. diff --git a/docs/dyn/area120tables_v1alpha1.tables.rows.html b/docs/dyn/area120tables_v1alpha1.tables.rows.html index 382dc7be6dd..1c438d9c566 100644 --- a/docs/dyn/area120tables_v1alpha1.tables.rows.html +++ b/docs/dyn/area120tables_v1alpha1.tables.rows.html @@ -96,7 +96,7 @@

Instance Methods

get(name, view=None, x__xgafv=None)

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

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

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

list_next(previous_request, previous_response)

@@ -320,12 +320,13 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists rows in a table. Returns NOT_FOUND if the table does not exist.
 
 Args:
   parent: string, Required. The parent table. Format: tables/{table} (required)
   filter: string, Optional. Filter to only include resources matching the requirements. For more information, see [Filtering list results](https://support.google.com/area120-tables/answer/10503371).
+  orderBy: string, Optional. Sorting order for the list of rows on createTime/updateTime.
   pageSize: integer, The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.
   pageToken: string, A page token, received from a previous `ListRows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRows` must match the call that provided the page token.
   view: string, Optional. Column key to use for values in the row. Defaults to user entered name.
diff --git a/docs/dyn/area120tables_v1alpha1.workspaces.html b/docs/dyn/area120tables_v1alpha1.workspaces.html
index 2b454873cc5..180a2727592 100644
--- a/docs/dyn/area120tables_v1alpha1.workspaces.html
+++ b/docs/dyn/area120tables_v1alpha1.workspaces.html
@@ -126,6 +126,7 @@ 

Method Details

"relationshipColumn": "A String", # The name of the relationship column associated with the lookup. "relationshipColumnId": "A String", # The id of the relationship column. }, + "multipleValuesDisallowed": True or False, # Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible. "name": "A String", # column name "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship. "linkedTable": "A String", # The name of the table this relationship is linked to. @@ -186,6 +187,7 @@

Method Details

"relationshipColumn": "A String", # The name of the relationship column associated with the lookup. "relationshipColumnId": "A String", # The id of the relationship column. }, + "multipleValuesDisallowed": True or False, # Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible. "name": "A String", # column name "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship. "linkedTable": "A String", # The name of the table this relationship is linked to. diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.html index a8cb94d872f..54a45b8d50f 100644 --- a/docs/dyn/artifactregistry_v1beta1.projects.locations.html +++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.html index b403e5566c2..787e21c4ac1 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.locations.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.versions.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.versions.html index b27dc1187fb..6babcb92eb9 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.versions.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.versions.html @@ -153,6 +153,9 @@

Method Details

{ # The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes. "createTime": "A String", # The time when the version was created. "description": "A String", # Optional. Description of the version, as specified in its metadata. + "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the only resource in use is DockerImage + "a_key": "", # Properties of the object. + }, "name": "A String", # The name of the version, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". "relatedTags": [ # Output only. A list of related tags. Will contain up to 100 tags that reference this version. { # Tags point to a version and represent an alternative name that can be used to access the version. @@ -192,6 +195,9 @@

Method Details

{ # The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes. "createTime": "A String", # The time when the version was created. "description": "A String", # Optional. Description of the version, as specified in its metadata. + "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the only resource in use is DockerImage + "a_key": "", # Properties of the object. + }, "name": "A String", # The name of the version, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". "relatedTags": [ # Output only. A list of related tags. Will contain up to 100 tags that reference this version. { # Tags point to a version and represent an alternative name that can be used to access the version. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 1f9e508d2ff..859d1f61d1c 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -242,7 +242,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -407,7 +407,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -580,7 +580,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -844,7 +844,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1009,7 +1009,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1182,7 +1182,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1351,7 +1351,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1515,7 +1515,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1680,7 +1680,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1853,7 +1853,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -2092,7 +2092,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -2257,7 +2257,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -2430,7 +2430,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -2692,7 +2692,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -2857,7 +2857,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -3035,7 +3035,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -3272,7 +3272,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index a3721ca58f8..91c7071121d 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -213,7 +213,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -306,7 +306,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -495,7 +495,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -588,7 +588,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -718,7 +718,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -811,7 +811,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1024,7 +1024,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1117,7 +1117,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1247,7 +1247,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1340,7 +1340,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1585,7 +1585,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1678,7 +1678,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1808,7 +1808,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", @@ -1901,7 +1901,7 @@

Method Details

], "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. + "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. "policyTags": { "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. "A String", diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.html index 64c644fd2cb..60437cc3cf6 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html index d0774ea0d09..f1de82498f7 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.capacityCommitments.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None)

+ create(parent, body=None, capacityCommitmentId=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None)

Creates a new capacity commitment resource.

delete(name, x__xgafv=None)

@@ -108,7 +108,7 @@

Method Details

- create(parent, body=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None) + create(parent, body=None, capacityCommitmentId=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None)
Creates a new capacity commitment resource.
 
 Args:
@@ -135,6 +135,7 @@ 

Method Details

"state": "A String", # Output only. State of the commitment. } + capacityCommitmentId: string, The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged. enforceSingleAdminProjectPerOrg: boolean, If true, fail the request if another project in the organization has a capacity commitment. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html index 172a63748dd..bf021ed8164 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. "None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.

delete(name, x__xgafv=None)

@@ -92,6 +92,9 @@

Instance Methods

move(name, body=None, x__xgafv=None)

Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

+

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

+

Updates an existing assignment. Only the `priority` field can be updated.

Method Details

close() @@ -99,7 +102,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, assignmentId=None, body=None, x__xgafv=None)
Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. "None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.
 
 Args:
@@ -114,6 +117,7 @@ 

Method Details

"state": "A String", # Output only. State of the assignment. } + assignmentId: string, The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -220,4 +224,37 @@

Method Details

}
+
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing assignment. Only the `priority` field can be updated.
+
+Args:
+  name: string, Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
+  "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
+  "jobType": "A String", # Which type of jobs will use the reservation.
+  "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
+  "state": "A String", # Output only. State of the assignment.
+}
+
+  updateMask: string, Standard field mask for the set of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
+  "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
+  "jobType": "A String", # Which type of jobs will use the reservation.
+  "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
+  "state": "A String", # Output only. State of the assignment.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html index 8f57c570ea4..d90dac9f09a 100644 --- a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html +++ b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None)

+ create(parent, body=None, capacityCommitmentId=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None)

Creates a new capacity commitment resource.

delete(name, x__xgafv=None)

@@ -108,7 +108,7 @@

Method Details

- create(parent, body=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None) + create(parent, body=None, capacityCommitmentId=None, enforceSingleAdminProjectPerOrg=None, x__xgafv=None)
Creates a new capacity commitment resource.
 
 Args:
@@ -135,6 +135,7 @@ 

Method Details

"state": "A String", # Output only. State of the commitment. } + capacityCommitmentId: string, The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged. enforceSingleAdminProjectPerOrg: boolean, If true, fail the request if another project in the organization has a capacity commitment. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html index 55241abb607..eae2ef30e3c 100644 --- a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. "None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.

delete(name, x__xgafv=None)

@@ -92,6 +92,9 @@

Instance Methods

move(name, body=None, x__xgafv=None)

Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

+

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

+

Updates an existing assignment. Only the `priority` field can be updated.

Method Details

close() @@ -99,7 +102,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, assignmentId=None, body=None, x__xgafv=None)
Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. "None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.
 
 Args:
@@ -114,6 +117,7 @@ 

Method Details

"state": "A String", # Output only. State of the assignment. } + assignmentId: string, The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -220,4 +224,37 @@

Method Details

}
+
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing assignment. Only the `priority` field can be updated.
+
+Args:
+  name: string, Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
+  "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
+  "jobType": "A String", # Which type of jobs will use the reservation.
+  "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
+  "state": "A String", # Output only. State of the assignment.
+}
+
+  updateMask: string, Standard field mask for the set of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
+  "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
+  "jobType": "A String", # Which type of jobs will use the reservation.
+  "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
+  "state": "A String", # Output only. State of the assignment.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.html b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.html index a2229e293b9..642805ea44a 100644 --- a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.html +++ b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.html @@ -118,7 +118,6 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "creationTime": "A String", # Output only. Creation time of the reservation. "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. - "maxConcurrency": "A String", # Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -136,7 +135,6 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "creationTime": "A String", # Output only. Creation time of the reservation. "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. - "maxConcurrency": "A String", # Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -178,7 +176,6 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "creationTime": "A String", # Output only. Creation time of the reservation. "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. - "maxConcurrency": "A String", # Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -208,7 +205,6 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "creationTime": "A String", # Output only. Creation time of the reservation. "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. - "maxConcurrency": "A String", # Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -243,7 +239,6 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "creationTime": "A String", # Output only. Creation time of the reservation. "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. - "maxConcurrency": "A String", # Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. "updateTime": "A String", # Output only. Last update time of the reservation. @@ -261,7 +256,6 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "creationTime": "A String", # Output only. Creation time of the reservation. "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. - "maxConcurrency": "A String", # Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. "updateTime": "A String", # Output only. Last update time of the reservation. diff --git a/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html b/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html index 7b4a4a77236..402ee18990f 100644 --- a/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html +++ b/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html @@ -121,12 +121,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -191,12 +191,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -286,12 +286,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -367,12 +367,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -456,12 +456,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -527,12 +527,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. diff --git a/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html b/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html index 2c323d0539b..3b5a689f3ce 100644 --- a/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html +++ b/docs/dyn/billingbudgets_v1beta1.billingAccounts.budgets.html @@ -130,12 +130,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -201,12 +201,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -296,12 +296,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -377,12 +377,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -467,12 +467,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. @@ -539,12 +539,12 @@

Method Details

}, }, "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. "A String", ], "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "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. diff --git a/docs/dyn/calendar_v3.colors.html b/docs/dyn/calendar_v3.colors.html index 65e76f35c1f..9330268cb03 100644 --- a/docs/dyn/calendar_v3.colors.html +++ b/docs/dyn/calendar_v3.colors.html @@ -96,13 +96,13 @@

Method Details

An object of the form: { - "calendar": { # A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only. - "a_key": { # A calendar color defintion. + "calendar": { # A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only. + "a_key": { # A calendar color definition. "background": "A String", # The background color associated with this color definition. "foreground": "A String", # The foreground color that can be used to write on top of a background with 'background' color. }, }, - "event": { # A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only. + "event": { # A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only. "a_key": { # An event color definition. "background": "A String", # The background color associated with this color definition. "foreground": "A String", # The foreground color that can be used to write on top of a background with 'background' color. diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html index 9c09f7052d8..19f2ee309c9 100644 --- a/docs/dyn/cloudasset_v1.v1.html +++ b/docs/dyn/cloudasset_v1.v1.html @@ -729,14 +729,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -747,7 +747,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -755,20 +755,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -779,7 +779,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, @@ -804,14 +804,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -822,7 +822,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -830,20 +830,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -854,7 +854,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, @@ -1157,14 +1157,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -1175,7 +1175,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -1183,20 +1183,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -1207,7 +1207,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, @@ -1232,14 +1232,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -1250,7 +1250,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -1258,20 +1258,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -1282,7 +1282,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, @@ -1474,7 +1474,7 @@

Method Details

orderBy: string, Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only string fields in the response are sortable, including `name`, `displayName`, `description`, `location`. All the other fields such as repeated fields (e.g., `networkTags`), map fields (e.g., `labels`) and struct fields (e.g., `additionalAttributes`) are not supported. pageSize: integer, Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as `next_page_token` is returned. pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call. - query: string, Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Cloud resources whose name contains "Important" as a word. * `name=Important` to find the Cloud resource whose name is exactly "Important". * `displayName:Impor*` to find Cloud resources whose display name contains "Impor" as a prefix of any word in the field. * `location:us-west*` to find Cloud resources whose location contains both "us" and "west" as prefixes. * `labels:prod` to find Cloud resources whose labels contain "prod" as a key or value. * `labels.env:prod` to find Cloud resources that have a label "env" and its value is "prod". * `labels.env:*` to find Cloud resources that have a label "env". * `kmsKey:key` to find Cloud resources encrypted with a customer-managed encryption key whose name contains the word "key". * `state:ACTIVE` to find Cloud resources whose state contains "ACTIVE" as a word. * `createTime<1609459200` to find Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds. * `updateTime>1609459200` to find Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds. * `Important` to find Cloud resources that contain "Important" as a word in any of the searchable fields. * `Impor*` to find Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location. + query: string, Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Cloud resources whose name contains "Important" as a word. * `name=Important` to find the Cloud resource whose name is exactly "Important". * `displayName:Impor*` to find Cloud resources whose display name contains "Impor" as a prefix of any word in the field. * `location:us-west*` to find Cloud resources whose location contains both "us" and "west" as prefixes. * `labels:prod` to find Cloud resources whose labels contain "prod" as a key or value. * `labels.env:prod` to find Cloud resources that have a label "env" and its value is "prod". * `labels.env:*` to find Cloud resources that have a label "env". * `kmsKey:key` to find Cloud resources encrypted with a customer-managed encryption key whose name contains the word "key". * `state:ACTIVE` to find Cloud resources whose state contains "ACTIVE" as a word. * `NOT state:ACTIVE` to find {{gcp_name}} resources whose state doesn't contain "ACTIVE" as a word. * `createTime<1609459200` to find Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds. * `updateTime>1609459200` to find Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds. * `Important` to find Cloud resources that contain "Important" as a word in any of the searchable fields. * `Impor*` to find Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudasset_v1beta1.organizations.html b/docs/dyn/cloudasset_v1beta1.organizations.html index d79dbfcc718..552d850542c 100644 --- a/docs/dyn/cloudasset_v1beta1.organizations.html +++ b/docs/dyn/cloudasset_v1beta1.organizations.html @@ -249,14 +249,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -267,7 +267,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -275,20 +275,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -299,7 +299,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, @@ -324,14 +324,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -342,7 +342,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -350,20 +350,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -374,7 +374,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html index 929cc7e6d63..0b85da0ed72 100644 --- a/docs/dyn/cloudasset_v1beta1.projects.html +++ b/docs/dyn/cloudasset_v1beta1.projects.html @@ -249,14 +249,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -267,7 +267,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -275,20 +275,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -299,7 +299,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, @@ -324,14 +324,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -342,7 +342,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -350,20 +350,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -374,7 +374,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, diff --git a/docs/dyn/cloudasset_v1p5beta1.assets.html b/docs/dyn/cloudasset_v1p5beta1.assets.html index 30d17867587..79e2777e09b 100644 --- a/docs/dyn/cloudasset_v1p5beta1.assets.html +++ b/docs/dyn/cloudasset_v1p5beta1.assets.html @@ -254,14 +254,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -272,7 +272,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -280,20 +280,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -304,7 +304,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, @@ -329,14 +329,14 @@

Method Details

], "egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. - "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. + "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. "identities": [ # A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. }, - "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. - "operations": [ # A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list. + "egressTo": { # Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter. # Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -347,7 +347,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter. + "resources": [ # A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. "A String", ], }, @@ -355,20 +355,20 @@

Method Details

], "ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. - "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. # Defines the conditions on the source of a request causing this IngressPolicy to apply. + "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. "identities": [ # A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. "sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. - "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], }, - "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. - "operations": [ # A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. + "ingressTo": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match. # Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. + "operations": [ # A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter. { # Identification for an API Operation. "methodSelectors": [ # API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`. { # An allowed method or permission of a service specified in ApiOperation. @@ -379,7 +379,7 @@

Method Details

"serviceName": "A String", # The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services. }, ], - "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field. + "resources": [ # A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. "A String", ], }, diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index de23dd4cd84..368828cd978 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -334,6 +334,7 @@

Method Details

"description": "A String", # Human-readable description of this trigger. "disabled": True or False, # If true, the trigger will never automatically execute a build. "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). + "filter": "A String", # Optional. A Common Expression Language string. "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. "installationId": "A String", # The installationID that emits the GitHub event. "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". @@ -357,6 +358,12 @@

Method Details

"A String", ], "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. + "pubsubConfig": { # PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. # Optional. PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. + "serviceAccountEmail": "A String", # Service account that will make the push request. + "state": "A String", # Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. + "subscription": "A String", # Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`. + "topic": "A String", # The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. + }, "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. "a_key": "A String", }, @@ -603,6 +610,7 @@

Method Details

"description": "A String", # Human-readable description of this trigger. "disabled": True or False, # If true, the trigger will never automatically execute a build. "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). + "filter": "A String", # Optional. A Common Expression Language string. "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. "installationId": "A String", # The installationID that emits the GitHub event. "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". @@ -626,6 +634,12 @@

Method Details

"A String", ], "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. + "pubsubConfig": { # PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. # Optional. PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. + "serviceAccountEmail": "A String", # Service account that will make the push request. + "state": "A String", # Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. + "subscription": "A String", # Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`. + "topic": "A String", # The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. + }, "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. "a_key": "A String", }, @@ -899,6 +913,7 @@

Method Details

"description": "A String", # Human-readable description of this trigger. "disabled": True or False, # If true, the trigger will never automatically execute a build. "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). + "filter": "A String", # Optional. A Common Expression Language string. "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. "installationId": "A String", # The installationID that emits the GitHub event. "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". @@ -922,6 +937,12 @@

Method Details

"A String", ], "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. + "pubsubConfig": { # PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. # Optional. PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. + "serviceAccountEmail": "A String", # Service account that will make the push request. + "state": "A String", # Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. + "subscription": "A String", # Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`. + "topic": "A String", # The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. + }, "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. "a_key": "A String", }, @@ -1180,6 +1201,7 @@

Method Details

"description": "A String", # Human-readable description of this trigger. "disabled": True or False, # If true, the trigger will never automatically execute a build. "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). + "filter": "A String", # Optional. A Common Expression Language string. "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. "installationId": "A String", # The installationID that emits the GitHub event. "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". @@ -1203,6 +1225,12 @@

Method Details

"A String", ], "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. + "pubsubConfig": { # PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. # Optional. PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. + "serviceAccountEmail": "A String", # Service account that will make the push request. + "state": "A String", # Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. + "subscription": "A String", # Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`. + "topic": "A String", # The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. + }, "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. "a_key": "A String", }, @@ -1468,6 +1496,7 @@

Method Details

"description": "A String", # Human-readable description of this trigger. "disabled": True or False, # If true, the trigger will never automatically execute a build. "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). + "filter": "A String", # Optional. A Common Expression Language string. "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. "installationId": "A String", # The installationID that emits the GitHub event. "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". @@ -1491,6 +1520,12 @@

Method Details

"A String", ], "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. + "pubsubConfig": { # PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. # Optional. PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. + "serviceAccountEmail": "A String", # Service account that will make the push request. + "state": "A String", # Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. + "subscription": "A String", # Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`. + "topic": "A String", # The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. + }, "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. "a_key": "A String", }, @@ -1737,6 +1772,7 @@

Method Details

"description": "A String", # Human-readable description of this trigger. "disabled": True or False, # If true, the trigger will never automatically execute a build. "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). + "filter": "A String", # Optional. A Common Expression Language string. "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. "installationId": "A String", # The installationID that emits the GitHub event. "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". @@ -1760,6 +1796,12 @@

Method Details

"A String", ], "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. + "pubsubConfig": { # PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. # Optional. PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. + "serviceAccountEmail": "A String", # Service account that will make the push request. + "state": "A String", # Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests. + "subscription": "A String", # Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`. + "topic": "A String", # The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. + }, "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. "a_key": "A String", }, diff --git a/docs/dyn/cloudcommerceprocurement_v1.html b/docs/dyn/cloudcommerceprocurement_v1.html new file mode 100644 index 00000000000..034452a4a5b --- /dev/null +++ b/docs/dyn/cloudcommerceprocurement_v1.html @@ -0,0 +1,111 @@ + + + +

Cloud Commerce Partner Procurement API

+

Instance Methods

+

+ providers() +

+

Returns the providers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html new file mode 100644 index 00000000000..6f84bcc6734 --- /dev/null +++ b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html @@ -0,0 +1,272 @@ + + + +

Cloud Commerce Partner Procurement API . providers . accounts

+

Instance Methods

+

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

+

Grants an approval on an Account.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a requested Account resource.

+

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

+

Lists Accounts that the provider has access to.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Rejects an approval on an Account.

+

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

+

Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.

+

Method Details

+
+ approve(name, body=None, x__xgafv=None) +
Grants an approval on an Account.
+
+Args:
+  name: string, The resource name of the account. Required. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PartnerProcurementService.ApproveAccount.
+  "approvalName": "A String", # The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.
+  "properties": { # Set of properties that should be associated with the account. Optional.
+    "a_key": "A String",
+  },
+  "reason": "A String", # Free form text string explaining the approval reason. Optional. Max allowed length: 256 bytes. Longer strings will be truncated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a requested Account resource.
+
+Args:
+  name: string, The name of the account to retrieve. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an account that was established by the customer on the service provider's system.
+  "approvals": [ # Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.
+    { # An approval for some action on an account.
+      "name": "A String", # Output only. The name of the approval.
+      "reason": "A String", # Output only. An explanation for the state of the approval.
+      "state": "A String", # Output only. The state of the approval.
+      "updateTime": "A String", # Optional. The last update timestamp of the approval.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation timestamp.
+  "inputProperties": { # Output only. The custom properties that were collected from the user to create this account.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
+  "provider": "A String", # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+  "state": "A String", # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
+  "updateTime": "A String", # Output only. The last update timestamp.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Accounts that the provider has access to.
+
+Args:
+  parent: string, The parent resource name. (required)
+  pageSize: integer, The maximum number of entries that are requested. Default size is 200.
+  pageToken: string, The token for fetching the next page.
+  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 [PartnerProcurementService.ListAccounts[].
+  "accounts": [ # The list of accounts in this response.
+    { # Represents an account that was established by the customer on the service provider's system.
+      "approvals": [ # Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.
+        { # An approval for some action on an account.
+          "name": "A String", # Output only. The name of the approval.
+          "reason": "A String", # Output only. An explanation for the state of the approval.
+          "state": "A String", # Output only. The state of the approval.
+          "updateTime": "A String", # Optional. The last update timestamp of the approval.
+        },
+      ],
+      "createTime": "A String", # Output only. The creation timestamp.
+      "inputProperties": { # Output only. The custom properties that were collected from the user to create this account.
+        "a_key": "", # Properties of the object.
+      },
+      "name": "A String", # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
+      "provider": "A String", # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+      "state": "A String", # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
+      "updateTime": "A String", # Output only. The last update timestamp.
+    },
+  ],
+  "nextPageToken": "A String", # The token for fetching the next page.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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.
+    
+
+ +
+ reject(name, body=None, x__xgafv=None) +
Rejects an approval on an Account.
+
+Args:
+  name: string, The resource name of the account. Required. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PartnerProcurementService.RejectAccount.
+  "approvalName": "A String", # The name of the approval being rejected. If absent and there is only one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.
+  "reason": "A String", # Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ reset(name, body=None, x__xgafv=None) +
Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.
+
+Args:
+  name: string, The resource name of the account. Required. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for for PartnerProcurementService.ResetAccount.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html b/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html new file mode 100644 index 00000000000..b7a241c086a --- /dev/null +++ b/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html @@ -0,0 +1,424 @@ + + + +

Cloud Commerce Partner Procurement API . providers . entitlements

+

Instance Methods

+

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

+

Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.

+

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

+

Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a requested Entitlement resource.

+

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

+

Lists Entitlements for which the provider has read access.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates an existing Entitlement.

+

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

+

Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.

+

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

+

Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.

+

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

+

Requests suspension of an active Entitlement. This is not yet supported.

+

Method Details

+
+ approve(name, body=None, x__xgafv=None) +
Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.
+
+Args:
+  name: string, The resource name of the entitlement. Required. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [PartnerProcurementService.ApproveEntitlement[].
+  "properties": { # Set of properties that should be associated with the entitlement. Optional.
+    "a_key": "A String",
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ approvePlanChange(name, body=None, x__xgafv=None) +
Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.
+
+Args:
+  name: string, The resource name of the entitlement. Required. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].
+  "pendingPlanName": "A String", # Name of the pending plan that is being approved. Required.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a requested Entitlement resource.
+
+Args:
+  name: string, The name of the entitlement to retrieve. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a procured product of a customer. Next Id: 23
+  "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any.
+  "consumers": [ # Output only. The resources using this entitlement, if applicable.
+    { # A resource using (consuming) this entitlement.
+      "project": "A String", # A project name with format `projects/`.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation timestamp.
+  "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement.
+    "a_key": "", # Properties of the object.
+  },
+  "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
+  "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
+  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
+  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
+  "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
+  "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
+  "productExternalName": "A String", # Output only. The identifier of the product that was procured.
+  "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+  "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
+  "state": "A String", # Output only. The state of the entitlement.
+  "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement.
+  "updateTime": "A String", # Output only. The last update timestamp.
+  "usageReportingId": "A String", # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Entitlements for which the provider has read access.
+
+Args:
+  parent: string, The parent resource name. (required)
+  filter: string, The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` Note that the consumers match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. Also note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product="providerId:productId"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.
+  pageSize: integer, The maximum number of entries that are requested.
+  pageToken: string, The token for fetching the next page.
+  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 PartnerProcurementService.ListEntitlements.
+  "entitlements": [ # The list of entitlements in this response.
+    { # Represents a procured product of a customer. Next Id: 23
+      "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any.
+      "consumers": [ # Output only. The resources using this entitlement, if applicable.
+        { # A resource using (consuming) this entitlement.
+          "project": "A String", # A project name with format `projects/`.
+        },
+      ],
+      "createTime": "A String", # Output only. The creation timestamp.
+      "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement.
+        "a_key": "", # Properties of the object.
+      },
+      "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
+      "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
+      "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+      "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
+      "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+      "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
+      "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
+      "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
+      "productExternalName": "A String", # Output only. The identifier of the product that was procured.
+      "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+      "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
+      "state": "A String", # Output only. The state of the entitlement.
+      "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement.
+      "updateTime": "A String", # Output only. The last update timestamp.
+      "usageReportingId": "A String", # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
+    },
+  ],
+  "nextPageToken": "A String", # The token for fetching the next page.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 an existing Entitlement.
+
+Args:
+  name: string, The name of the entitlement to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a procured product of a customer. Next Id: 23
+  "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any.
+  "consumers": [ # Output only. The resources using this entitlement, if applicable.
+    { # A resource using (consuming) this entitlement.
+      "project": "A String", # A project name with format `projects/`.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation timestamp.
+  "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement.
+    "a_key": "", # Properties of the object.
+  },
+  "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
+  "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
+  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
+  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
+  "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
+  "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
+  "productExternalName": "A String", # Output only. The identifier of the product that was procured.
+  "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+  "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
+  "state": "A String", # Output only. The state of the entitlement.
+  "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement.
+  "updateTime": "A String", # Output only. The last update timestamp.
+  "usageReportingId": "A String", # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
+}
+
+  updateMask: string, The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a procured product of a customer. Next Id: 23
+  "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any.
+  "consumers": [ # Output only. The resources using this entitlement, if applicable.
+    { # A resource using (consuming) this entitlement.
+      "project": "A String", # A project name with format `projects/`.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation timestamp.
+  "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement.
+    "a_key": "", # Properties of the object.
+  },
+  "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
+  "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
+  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
+  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
+  "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
+  "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
+  "productExternalName": "A String", # Output only. The identifier of the product that was procured.
+  "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+  "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
+  "state": "A String", # Output only. The state of the entitlement.
+  "subscriptionEndTime": "A String", # Output only. End time for the subscription corresponding to this entitlement.
+  "updateTime": "A String", # Output only. The last update timestamp.
+  "usageReportingId": "A String", # Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
+}
+
+ +
+ reject(name, body=None, x__xgafv=None) +
Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.
+
+Args:
+  name: string, The resource name of the entitlement. Required. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PartnerProcurementService.RejectEntitlement.
+  "reason": "A String", # Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ rejectPlanChange(name, body=None, x__xgafv=None) +
Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.
+
+Args:
+  name: string, The resource name of the entitlement. Required. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PartnerProcurementService.RejectEntitlementPlanChange.
+  "pendingPlanName": "A String", # Name of the pending plan that is being rejected. Required.
+  "reason": "A String", # Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ suspend(name, body=None, x__xgafv=None) +
Requests suspension of an active Entitlement. This is not yet supported.
+
+Args:
+  name: string, The name of the entitlement to suspend. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported.
+  "reason": "A String", # A free-form reason string, explaining the reason for suspension request.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.html b/docs/dyn/cloudcommerceprocurement_v1.providers.html new file mode 100644 index 00000000000..0b1130f9c61 --- /dev/null +++ b/docs/dyn/cloudcommerceprocurement_v1.providers.html @@ -0,0 +1,96 @@ + + + +

Cloud Commerce Partner Procurement API . providers

+

Instance Methods

+

+ accounts() +

+

Returns the accounts Resource.

+ +

+ entitlements() +

+

Returns the entitlements Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.html b/docs/dyn/cloudfunctions_v1.projects.locations.html index 455bdad4af5..869c4a747e1 100644 --- a/docs/dyn/cloudfunctions_v1.projects.locations.html +++ b/docs/dyn/cloudfunctions_v1.projects.locations.html @@ -101,7 +101,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudkms_v1.projects.locations.html b/docs/dyn/cloudkms_v1.projects.locations.html index 13c233310f8..8e3d8f957be 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.html +++ b/docs/dyn/cloudkms_v1.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.html b/docs/dyn/cloudscheduler_v1.projects.locations.html index 57c0e13ed4c..6aaa7a3513c 100644 --- a/docs/dyn/cloudscheduler_v1.projects.locations.html +++ b/docs/dyn/cloudscheduler_v1.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html index 6bc70ec05b6..ef53d75674f 100644 --- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html +++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudsearch_v1.debug.datasources.items.html b/docs/dyn/cloudsearch_v1.debug.datasources.items.html index d78747d448d..a3828bb815b 100644 --- a/docs/dyn/cloudsearch_v1.debug.datasources.items.html +++ b/docs/dyn/cloudsearch_v1.debug.datasources.items.html @@ -207,6 +207,14 @@

Method Details

"metadata": { # Available metadata fields for the item. # Metadata information. "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. + "contextAttributes": [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. + { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. + "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + "A String", + ], + }, + ], "createTime": "A String", # The time when the item was created in the source repository. "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. "interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html index 8c3abe10195..06d0f44df71 100644 --- a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html +++ b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html @@ -268,6 +268,14 @@

Method Details

"metadata": { # Available metadata fields for the item. # Metadata information. "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. + "contextAttributes": [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. + { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. + "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + "A String", + ], + }, + ], "createTime": "A String", # The time when the item was created in the source repository. "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. "interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. @@ -448,6 +456,14 @@

Method Details

"metadata": { # Available metadata fields for the item. # Metadata information. "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. + "contextAttributes": [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. + { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. + "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + "A String", + ], + }, + ], "createTime": "A String", # The time when the item was created in the source repository. "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. "interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. @@ -662,6 +678,14 @@

Method Details

"metadata": { # Available metadata fields for the item. # Metadata information. "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. + "contextAttributes": [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. + { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. + "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + "A String", + ], + }, + ], "createTime": "A String", # The time when the item was created in the source repository. "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. "interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. @@ -873,6 +897,14 @@

Method Details

"metadata": { # Available metadata fields for the item. # Metadata information. "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. + "contextAttributes": [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. + { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. + "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + "A String", + ], + }, + ], "createTime": "A String", # The time when the item was created in the source repository. "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. "interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. @@ -1075,6 +1107,14 @@

Method Details

"metadata": { # Available metadata fields for the item. # Metadata information. "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. + "contextAttributes": [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10. + { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. + "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + "A String", + ], + }, + ], "createTime": "A String", # The time when the item was created in the source repository. "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. "interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html index a089fdee18f..3368515bb2e 100644 --- a/docs/dyn/cloudsearch_v1.query.html +++ b/docs/dyn/cloudsearch_v1.query.html @@ -103,6 +103,14 @@

Method Details

The object takes the form of: { # The search API request. + "contextAttributes": [ # Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10. + { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. + "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. + "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. + "A String", + ], + }, + ], "dataSourceRestrictions": [ # The sources to use for querying. If not specified, all data sources from the current search application are used. { # Restriction on Datasource. "filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions. diff --git a/docs/dyn/cloudsearch_v1.settings.html b/docs/dyn/cloudsearch_v1.settings.html index 6d3ea95b100..5a49ad34276 100644 --- a/docs/dyn/cloudsearch_v1.settings.html +++ b/docs/dyn/cloudsearch_v1.settings.html @@ -113,6 +113,12 @@

Method Details

An object of the form: { # Represents settings at a customer level. + "auditLoggingSettings": { # Represents the settings for Cloud audit logging # Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. + "logAdminReadActions": True or False, # Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc. + "logDataReadActions": True or False, # Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc. + "logDataWriteActions": True or False, # Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc. + "project": "A String", # The resource name of the GCP Project to store audit logs. Cloud audit logging will be enabled after project_name has been updated through CustomerService. Format: projects/{project_id} + }, "vpcSettings": { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. "project": "A String", # The resource name of the GCP Project to be used for VPC SC policy check. VPC security settings on this project will be honored for Cloud Search APIs after project_name has been updated through CustomerService. Format: projects/{project_id} }, @@ -128,6 +134,12 @@

Method Details

The object takes the form of: { # Represents settings at a customer level. + "auditLoggingSettings": { # Represents the settings for Cloud audit logging # Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. + "logAdminReadActions": True or False, # Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc. + "logDataReadActions": True or False, # Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc. + "logDataWriteActions": True or False, # Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc. + "project": "A String", # The resource name of the GCP Project to store audit logs. Cloud audit logging will be enabled after project_name has been updated through CustomerService. Format: projects/{project_id} + }, "vpcSettings": { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request. "project": "A String", # The resource name of the GCP Project to be used for VPC SC policy check. VPC security settings on this project will be honored for Cloud Search APIs after project_name has been updated through CustomerService. Format: projects/{project_id} }, diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html index 6795bf3fdf0..dce0532a212 100644 --- a/docs/dyn/cloudsearch_v1.settings.searchapplications.html +++ b/docs/dyn/cloudsearch_v1.settings.searchapplications.html @@ -162,6 +162,7 @@

Method Details

"sortOrder": "A String", # Ascending is the default sort order }, "displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters. + "enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs. "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}. "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field. "A String", @@ -317,6 +318,7 @@

Method Details

"sortOrder": "A String", # Ascending is the default sort order }, "displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters. + "enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs. "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}. "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field. "A String", @@ -412,6 +414,7 @@

Method Details

"sortOrder": "A String", # Ascending is the default sort order }, "displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters. + "enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs. "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}. "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field. "A String", @@ -557,6 +560,7 @@

Method Details

"sortOrder": "A String", # Ascending is the default sort order }, "displayName": "A String", # Display name of the Search Application. The maximum length is 300 characters. + "enableAuditLog": True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs. "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}. "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field. "A String", diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 95b465b5b4a..335a70bd89b 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -338,6 +338,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -904,6 +905,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -1373,6 +1375,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 9fdfdc5873e..7d384c49a32 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -439,6 +439,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -1005,6 +1006,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -1518,6 +1520,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 207df627e74..d7183019639 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -349,6 +349,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -446,6 +447,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -531,6 +533,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -683,6 +686,9 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. @@ -958,6 +964,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -1055,6 +1062,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1140,6 +1148,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1292,6 +1301,9 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. @@ -1470,6 +1482,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -1567,6 +1580,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1652,6 +1666,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1804,6 +1819,9 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. @@ -2848,6 +2866,9 @@

Method Details

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "desiredWorkloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index bcd289e0262..602c07bcf0b 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -140,6 +140,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -412,6 +413,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -550,6 +552,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1013,7 +1016,7 @@

Method Details

"nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - "tags": { # Collection of Compute Engine network tags that can be applied to a node's underyling VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. + "tags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. "tags": [ # List of network tags. "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 5f4f335fbe5..6ecbc678a7b 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -457,6 +457,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -554,6 +555,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -639,6 +641,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -791,6 +794,9 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. @@ -1066,6 +1072,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -1163,6 +1170,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1248,6 +1256,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1400,6 +1409,9 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. @@ -1622,6 +1634,7 @@

Method Details

"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "id": "A String", # Output only. Unique id for the cluster. "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. @@ -1719,6 +1732,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1804,6 +1818,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1956,6 +1971,9 @@

Method Details

"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. @@ -2909,6 +2927,9 @@

Method Details

"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, + "desiredWorkloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index bebe222e416..f1c71c3ffda 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -229,6 +229,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -501,6 +502,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -639,6 +641,7 @@

Method Details

{ # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). }, ], "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption @@ -1030,7 +1033,7 @@

Method Details

"nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - "tags": { # Collection of Compute Engine network tags that can be applied to a node's underyling VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. + "tags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. "tags": [ # List of network tags. "A String", ], diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html index 9d5256cc086..175d684eb59 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html @@ -245,6 +245,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -382,6 +383,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -542,6 +544,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -734,6 +737,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -887,6 +891,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -1023,6 +1028,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html index a5e06f9e2b1..ced5fc2c312 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html @@ -1219,6 +1219,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html index 0769318114b..ac27058c550 100644 --- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html @@ -245,6 +245,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -382,6 +383,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -542,6 +544,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -734,6 +737,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -887,6 +891,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability @@ -1023,6 +1028,7 @@

Method Details

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. + "vendor": "A String", # The vendor of the product. e.g. "google" }, ], "severity": "A String", # Note provider assigned impact of the vulnerability diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.html index 45da476d1fc..7ae8d500959 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.notes.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.html @@ -271,6 +271,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. @@ -450,6 +451,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. @@ -634,6 +636,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. @@ -810,6 +813,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. @@ -1010,6 +1014,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. @@ -1241,6 +1246,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. @@ -1434,6 +1440,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. @@ -1610,6 +1617,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html index 3ddab28c68c..f42be6329f7 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html @@ -1915,6 +1915,7 @@

Method Details

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. "source": "A String", # The source from which the information in this Detail was obtained. "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. + "vendor": "A String", # The name of the vendor of the product. }, ], "severity": "A String", # Note provider assigned impact of the vulnerability. diff --git a/docs/dyn/content_v2.shippingsettings.html b/docs/dyn/content_v2.shippingsettings.html index 468e7d52e08..fcd7a7d00f5 100644 --- a/docs/dyn/content_v2.shippingsettings.html +++ b/docs/dyn/content_v2.shippingsettings.html @@ -188,6 +188,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -490,6 +501,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -784,6 +806,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -1011,8 +1044,11 @@

Method Details

"carriers": [ # A list of supported carriers. May be empty. { "country": "A String", # The CLDR country code of the carrier (e.g., "US"). Always present. + "eddServices": [ # A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService. + "A String", + ], "name": "A String", # The name of the carrier (e.g., `"UPS"`). Always present. - "services": [ # A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service. + "services": [ # A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService. "A String", ], }, @@ -1162,6 +1198,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -1463,6 +1510,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -1746,6 +1804,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. diff --git a/docs/dyn/content_v2_1.accounts.html b/docs/dyn/content_v2_1.accounts.html index 609872bd0c6..00e03651744 100644 --- a/docs/dyn/content_v2_1.accounts.html +++ b/docs/dyn/content_v2_1.accounts.html @@ -593,9 +593,13 @@

Method Details

{ "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`" - "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" + "linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`" "linkedAccountId": "A String", # The ID of the linked account. - "services": [ # Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" + "paymentServiceProviderLinkInfo": { # Additional information required for PAYMENT_SERVICE_PROVIDER link type. # Additional information required for `paymentServiceProvider` link type. + "externalAccountBusinessCountry": "A String", # The business country of the merchant account as identified by the third party service provider. + "externalAccountId": "A String", # The id used by the third party service provider to identify the merchant. + }, + "services": [ # Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`" "A String", ], } @@ -736,7 +740,7 @@

Method Details

"linkedAccountId": "A String", # The ID of the linked account. "services": [ # List of provided services. { - "service": "A String", # Service provided to or by the linked account. Acceptable values are: - "`shoppingActionsOrderManagement`" - "`shoppingActionsProductManagement`" - "`shoppingAdsProductManagement`" + "service": "A String", # Service provided to or by the linked account. Acceptable values are: - "`shoppingActionsOrderManagement`" - "`shoppingActionsProductManagement`" - "`shoppingAdsProductManagement`" - "`paymentProcessing`" "status": "A String", # Status of the link Acceptable values are: - "`active`" - "`inactive`" - "`pending`" }, ], diff --git a/docs/dyn/content_v2_1.shippingsettings.html b/docs/dyn/content_v2_1.shippingsettings.html index 43cc6bd04aa..6f12775deee 100644 --- a/docs/dyn/content_v2_1.shippingsettings.html +++ b/docs/dyn/content_v2_1.shippingsettings.html @@ -188,6 +188,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address. + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -489,6 +500,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address. + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -783,6 +805,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address. + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -1010,8 +1043,11 @@

Method Details

"carriers": [ # A list of supported carriers. May be empty. { "country": "A String", # The CLDR country code of the carrier (e.g., "US"). Always present. + "eddServices": [ # A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService. + "A String", + ], "name": "A String", # The name of the carrier (e.g., `"UPS"`). Always present. - "services": [ # A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service. + "services": [ # A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService. "A String", ], }, @@ -1161,6 +1197,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address. + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -1462,6 +1509,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address. + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. @@ -1744,6 +1802,17 @@

Method Details

"A String", ], }, + "warehouseBasedDeliveryTimes": [ # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. + { + "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. + "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. + "originAdministrativeArea": "A String", # Required. Shipping origin's state. + "originCity": "A String", # Required. Shipping origin's city. + "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Required. Shipping origin. + "originStreetAddress": "A String", # Shipping origin's street address. + }, + ], }, "eligibility": "A String", # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" "minimumOrderValue": { # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index 661cda1bbe8..599fea4181a 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.html @@ -1848,6 +1848,7 @@

Method Details

"topicName": "A String", # The name of the Pubsub topic. }, ], + "region": "A String", # Cloud region where this snapshot lives in, e.g., "us-central1". "sourceJobId": "A String", # The job this snapshot was created from. "state": "A String", # State of the snapshot. "ttl": "A String", # The time after which this snapshot will be automatically deleted. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html index 68ea1cfd90f..8b1dc76df60 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html @@ -115,6 +115,7 @@

Method Details

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". "numWorkers": 42, # The initial number of Google Compute Engine instances for the job. "serviceAccountEmail": "A String", # The email address of the service account to run the job as. + "stagingLocation": "A String", # The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`. "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. @@ -127,6 +128,9 @@

Method Details

"name": "A String", # Required. The name of the template. "parameters": [ # The parameters for the template. { # Metadata for a specific parameter. + "customMetadata": { # Optional. Additional metadata for describing this parameter. + "a_key": "A String", + }, "helpText": "A String", # Required. The help text to display for the parameter. "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. "label": "A String", # Required. The label to display for the parameter. @@ -160,6 +164,7 @@

Method Details

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". "numWorkers": 42, # The initial number of Google Compute Engine instances for the job. "serviceAccountEmail": "A String", # The email address of the service account to run the job as. + "stagingLocation": "A String", # The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`. "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. "tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. "workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html index 02cd320a590..56b502b3b1a 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html @@ -1583,6 +1583,7 @@

Method Details

"topicName": "A String", # The name of the Pubsub topic. }, ], + "region": "A String", # Cloud region where this snapshot lives in, e.g., "us-central1". "sourceJobId": "A String", # The job this snapshot was created from. "state": "A String", # State of the snapshot. "ttl": "A String", # The time after which this snapshot will be automatically deleted. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.snapshots.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.snapshots.html index 6635740d589..d616822f399 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.snapshots.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.snapshots.html @@ -117,6 +117,7 @@

Method Details

"topicName": "A String", # The name of the Pubsub topic. }, ], + "region": "A String", # Cloud region where this snapshot lives in, e.g., "us-central1". "sourceJobId": "A String", # The job this snapshot was created from. "state": "A String", # State of the snapshot. "ttl": "A String", # The time after which this snapshot will be automatically deleted. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.snapshots.html b/docs/dyn/dataflow_v1b3.projects.locations.snapshots.html index 29caf4c22e0..caef8b941e3 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.snapshots.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.snapshots.html @@ -141,6 +141,7 @@

Method Details

"topicName": "A String", # The name of the Pubsub topic. }, ], + "region": "A String", # Cloud region where this snapshot lives in, e.g., "us-central1". "sourceJobId": "A String", # The job this snapshot was created from. "state": "A String", # State of the snapshot. "ttl": "A String", # The time after which this snapshot will be automatically deleted. @@ -178,6 +179,7 @@

Method Details

"topicName": "A String", # The name of the Pubsub topic. }, ], + "region": "A String", # Cloud region where this snapshot lives in, e.g., "us-central1". "sourceJobId": "A String", # The job this snapshot was created from. "state": "A String", # State of the snapshot. "ttl": "A String", # The time after which this snapshot will be automatically deleted. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index d7b4dc44b95..3688c35f7e5 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -464,6 +464,9 @@

Method Details

"name": "A String", # Required. The name of the template. "parameters": [ # The parameters for the template. { # Metadata for a specific parameter. + "customMetadata": { # Optional. Additional metadata for describing this parameter. + "a_key": "A String", + }, "helpText": "A String", # Required. The help text to display for the parameter. "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. "label": "A String", # Required. The label to display for the parameter. @@ -478,6 +481,9 @@

Method Details

"runtimeMetadata": { # RuntimeMetadata describing a runtime environment. # Describes the runtime metadata with SDKInfo and available parameters. "parameters": [ # The parameters for the template. { # Metadata for a specific parameter. + "customMetadata": { # Optional. Additional metadata for describing this parameter. + "a_key": "A String", + }, "helpText": "A String", # Required. The help text to display for the parameter. "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. "label": "A String", # Required. The label to display for the parameter. diff --git a/docs/dyn/dataflow_v1b3.projects.snapshots.html b/docs/dyn/dataflow_v1b3.projects.snapshots.html index f7c96b62b8e..a3761446608 100644 --- a/docs/dyn/dataflow_v1b3.projects.snapshots.html +++ b/docs/dyn/dataflow_v1b3.projects.snapshots.html @@ -118,6 +118,7 @@

Method Details

"topicName": "A String", # The name of the Pubsub topic. }, ], + "region": "A String", # Cloud region where this snapshot lives in, e.g., "us-central1". "sourceJobId": "A String", # The job this snapshot was created from. "state": "A String", # State of the snapshot. "ttl": "A String", # The time after which this snapshot will be automatically deleted. @@ -155,6 +156,7 @@

Method Details

"topicName": "A String", # The name of the Pubsub topic. }, ], + "region": "A String", # Cloud region where this snapshot lives in, e.g., "us-central1". "sourceJobId": "A String", # The job this snapshot was created from. "state": "A String", # State of the snapshot. "ttl": "A String", # The time after which this snapshot will be automatically deleted. diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index d3192304a5e..7f0db5408ab 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -463,6 +463,9 @@

Method Details

"name": "A String", # Required. The name of the template. "parameters": [ # The parameters for the template. { # Metadata for a specific parameter. + "customMetadata": { # Optional. Additional metadata for describing this parameter. + "a_key": "A String", + }, "helpText": "A String", # Required. The help text to display for the parameter. "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. "label": "A String", # Required. The label to display for the parameter. @@ -477,6 +480,9 @@

Method Details

"runtimeMetadata": { # RuntimeMetadata describing a runtime environment. # Describes the runtime metadata with SDKInfo and available parameters. "parameters": [ # The parameters for the template. { # Metadata for a specific parameter. + "customMetadata": { # Optional. Additional metadata for describing this parameter. + "a_key": "A String", + }, "helpText": "A String", # Required. The help text to display for the parameter. "isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false. "label": "A String", # Required. The label to display for the parameter. diff --git a/docs/dyn/datamigration_v1.projects.locations.html b/docs/dyn/datamigration_v1.projects.locations.html index 2b215431f62..e371e96517d 100644 --- a/docs/dyn/datamigration_v1.projects.locations.html +++ b/docs/dyn/datamigration_v1.projects.locations.html @@ -141,7 +141,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/datamigration_v1beta1.projects.locations.html b/docs/dyn/datamigration_v1beta1.projects.locations.html index fb9c2109bf3..3bba587b14f 100644 --- a/docs/dyn/datamigration_v1beta1.projects.locations.html +++ b/docs/dyn/datamigration_v1beta1.projects.locations.html @@ -141,7 +141,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dialogflow_v2.projects.agent.environments.html b/docs/dyn/dialogflow_v2.projects.agent.environments.html index dc4b165706b..47de8aefb06 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.environments.html +++ b/docs/dyn/dialogflow_v2.projects.agent.environments.html @@ -87,24 +87,275 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates an agent environment.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified agent environment.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent environment.

+

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

+

Gets the history of the specified environment.

+

+ getHistory_next(previous_request, previous_response)

+

Retrieves the next page of results.

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

Returns the list of all non-draft environments of the specified agent.

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, environmentId=None, x__xgafv=None) +
Creates an agent environment.
+
+Args:
+  parent: string, Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  environmentId: string, Required. The unique id of the new environment.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ getHistory(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets the history of the specified environment.
+
+Args:
+  parent: string, Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Environments.GetEnvironmentHistory.
+  "entries": [ # Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.
+    { # Represents an environment history entry.
+      "agentVersion": "A String", # The agent version loaded into this environment history entry.
+      "createTime": "A String", # The creation time of this environment history entry.
+      "description": "A String", # The developer-provided description for this environment history entry.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "parent": "A String", # Output only. The name of the environment this history is for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+}
+
+ +
+ getHistory_next(previous_request, previous_response) +
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(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all non-draft environments of the specified agent.
 
 Args:
-  parent: string, Required. The agent to list all environments from. Format: `projects//agent`. (required)
+  parent: string, Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent` (required)
   pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
   pageToken: string, Optional. The next_page_token value returned from a previous list request.
   x__xgafv: string, V1 error format.
@@ -118,10 +369,48 @@ 

Method Details

{ # The response message for Environments.ListEnvironments. "environments": [ # The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request. { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). - "agentVersion": "A String", # Optional. The agent version loaded into this environment. Format: `projects//agent/versions/`. + "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. - "name": "A String", # Output only. The unique identifier of this agent environment. Format: `projects//agent/environments/`. For Environment ID, "-" is reserved for 'draft' environment. + "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment. + "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. + "enabled": True or False, # Optional. Whether fulfillment is enabled. + "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. + { # Whether fulfillment is enabled for the specific feature. + "type": "A String", # The type of the feature that enabled for fulfillment. + }, + ], + "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. + "password": "A String", # Optional. The password for HTTP Basic authentication. + "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. + "a_key": "A String", + }, + "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. + "username": "A String", # Optional. The user name for HTTP Basic authentication. + }, + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. + }, + "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment. + "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained. + "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. + "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). + "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig. + "a_key": { # Configuration of how speech should be synthesized. + "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. + "A String", + ], + "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. + "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. + "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. + "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. + "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. + }, + "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. + }, + }, + }, "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. }, ], @@ -143,4 +432,116 @@

Method Details

+
+ patch(name, allowLoadToDraftAndDiscardChanges=None, body=None, updateMask=None, x__xgafv=None) +
Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.
+
+Args:
+  name: string, Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  allowLoadToDraftAndDiscardChanges: boolean, Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html index 6959d0ea068..a79499a97e4 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html @@ -189,7 +189,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2.projects.agent.html b/docs/dyn/dialogflow_v2.projects.agent.html index 82b3bb9c3ed..b75a0410ad5 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.html +++ b/docs/dyn/dialogflow_v2.projects.agent.html @@ -99,6 +99,11 @@

Instance Methods

Returns the sessions Resource.

+

+ versions() +

+

Returns the versions Resource.

+

close()

Close httplib2 connections.

@@ -192,7 +197,7 @@

Method Details

An object of the form: { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). - "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. + "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. "enabled": True or False, # Optional. Whether fulfillment is enabled. "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. { # Whether fulfillment is enabled for the specific feature. @@ -200,7 +205,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # Optional. The password for HTTP Basic authentication. "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -208,7 +213,7 @@

Method Details

"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. "username": "A String", # Optional. The user name for HTTP Basic authentication. }, - "name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. }
@@ -425,12 +430,12 @@

Method Details

Updates the fulfillment.
 
 Args:
-  name: string, Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. (required)
+  name: string, Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
-  "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
+  "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
   "enabled": True or False, # Optional. Whether fulfillment is enabled.
   "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
     { # Whether fulfillment is enabled for the specific feature.
@@ -438,7 +443,7 @@ 

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # Optional. The password for HTTP Basic authentication. "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -446,7 +451,7 @@

Method Details

"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. "username": "A String", # Optional. The user name for HTTP Basic authentication. }, - "name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. } updateMask: string, Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. @@ -459,7 +464,7 @@

Method Details

An object of the form: { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). - "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. + "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. "enabled": True or False, # Optional. Whether fulfillment is enabled. "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. { # Whether fulfillment is enabled for the specific feature. @@ -467,7 +472,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # Optional. The password for HTTP Basic authentication. "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -475,7 +480,7 @@

Method Details

"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. "username": "A String", # Optional. The user name for HTTP Basic authentication. }, - "name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. }
diff --git a/docs/dyn/dialogflow_v2.projects.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.sessions.html index 7a399927d21..fce4c1c1b5a 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.sessions.html @@ -189,7 +189,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2.projects.agent.versions.html b/docs/dyn/dialogflow_v2.projects.agent.versions.html new file mode 100644 index 00000000000..6d34bdfc8f0 --- /dev/null +++ b/docs/dyn/dialogflow_v2.projects.agent.versions.html @@ -0,0 +1,258 @@ + + + +

Dialogflow API . projects . agent . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an agent version. The new version points to the agent instance in the "default" environment.

+

+ delete(name, x__xgafv=None)

+

Delete the specified agent version.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent version.

+

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

+

Returns the list of all versions of the specified agent.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an agent version. The new version points to the agent instance in the "default" environment.
+
+Args:
+  parent: string, Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete the specified agent version.
+
+Args:
+  name: string, Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent version.
+
+Args:
+  name: string, Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all versions of the specified agent.
+
+Args:
+  parent: string, Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Versions.ListVersions.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "versions": [ # The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request.
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+      "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+      "description": "A String", # Optional. The developer-provided description of this version.
+      "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+      "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+      "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
+
+Args:
+  name: string, Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index d938ec52996..efa291c5af9 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -121,7 +121,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -161,7 +161,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -255,7 +255,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -295,7 +295,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -414,7 +414,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -454,7 +454,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -559,7 +559,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -599,7 +599,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -712,7 +712,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -752,7 +752,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -847,7 +847,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -887,7 +887,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index 0dabd4a51f7..c6f578a6641 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -128,7 +128,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.html b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.html index f905d629caa..fb398a99484 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.html @@ -82,24 +82,275 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates an agent environment.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified agent environment.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent environment.

+

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

+

Gets the history of the specified environment.

+

+ getHistory_next(previous_request, previous_response)

+

Retrieves the next page of results.

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

Returns the list of all non-draft environments of the specified agent.

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, environmentId=None, x__xgafv=None) +
Creates an agent environment.
+
+Args:
+  parent: string, Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  environmentId: string, Required. The unique id of the new environment.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ getHistory(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets the history of the specified environment.
+
+Args:
+  parent: string, Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Environments.GetEnvironmentHistory.
+  "entries": [ # Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.
+    { # Represents an environment history entry.
+      "agentVersion": "A String", # The agent version loaded into this environment history entry.
+      "createTime": "A String", # The creation time of this environment history entry.
+      "description": "A String", # The developer-provided description for this environment history entry.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "parent": "A String", # Output only. The name of the environment this history is for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+}
+
+ +
+ getHistory_next(previous_request, previous_response) +
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(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all non-draft environments of the specified agent.
 
 Args:
-  parent: string, Required. The agent to list all environments from. Format: `projects//agent`. (required)
+  parent: string, Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent` (required)
   pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
   pageToken: string, Optional. The next_page_token value returned from a previous list request.
   x__xgafv: string, V1 error format.
@@ -113,10 +364,48 @@ 

Method Details

{ # The response message for Environments.ListEnvironments. "environments": [ # The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request. { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). - "agentVersion": "A String", # Optional. The agent version loaded into this environment. Format: `projects//agent/versions/`. + "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. - "name": "A String", # Output only. The unique identifier of this agent environment. Format: `projects//agent/environments/`. For Environment ID, "-" is reserved for 'draft' environment. + "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment. + "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. + "enabled": True or False, # Optional. Whether fulfillment is enabled. + "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. + { # Whether fulfillment is enabled for the specific feature. + "type": "A String", # The type of the feature that enabled for fulfillment. + }, + ], + "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. + "password": "A String", # Optional. The password for HTTP Basic authentication. + "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. + "a_key": "A String", + }, + "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. + "username": "A String", # Optional. The user name for HTTP Basic authentication. + }, + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. + }, + "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment. + "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained. + "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. + "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). + "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig. + "a_key": { # Configuration of how speech should be synthesized. + "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. + "A String", + ], + "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. + "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. + "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. + "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. + "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. + }, + "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. + }, + }, + }, "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. }, ], @@ -138,4 +427,116 @@

Method Details

+
+ patch(name, allowLoadToDraftAndDiscardChanges=None, body=None, updateMask=None, x__xgafv=None) +
Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.
+
+Args:
+  name: string, Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  allowLoadToDraftAndDiscardChanges: boolean, Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Optional. Whether fulfillment is enabled.
+    "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # Optional. The password for HTTP Basic authentication.
+      "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # Optional. The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html index 25ddd3769f0..f61c60cc313 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html @@ -189,7 +189,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.html b/docs/dyn/dialogflow_v2.projects.locations.agent.html index 23e8da8d42d..6b40c9cadc5 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.html @@ -94,6 +94,11 @@

Instance Methods

Returns the sessions Resource.

+

+ versions() +

+

Returns the versions Resource.

+

close()

Close httplib2 connections.

@@ -187,7 +192,7 @@

Method Details

An object of the form: { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). - "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. + "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. "enabled": True or False, # Optional. Whether fulfillment is enabled. "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. { # Whether fulfillment is enabled for the specific feature. @@ -195,7 +200,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # Optional. The password for HTTP Basic authentication. "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -203,7 +208,7 @@

Method Details

"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. "username": "A String", # Optional. The user name for HTTP Basic authentication. }, - "name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. } @@ -420,12 +425,12 @@

Method Details

Updates the fulfillment.
 
 Args:
-  name: string, Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. (required)
+  name: string, Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
-  "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.
+  "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
   "enabled": True or False, # Optional. Whether fulfillment is enabled.
   "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.
     { # Whether fulfillment is enabled for the specific feature.
@@ -433,7 +438,7 @@ 

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # Optional. The password for HTTP Basic authentication. "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -441,7 +446,7 @@

Method Details

"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. "username": "A String", # Optional. The user name for HTTP Basic authentication. }, - "name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. } updateMask: string, Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. @@ -454,7 +459,7 @@

Method Details

An object of the form: { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). - "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. + "displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. "enabled": True or False, # Optional. Whether fulfillment is enabled. "features": [ # Optional. The field defines whether the fulfillment is enabled for certain features. { # Whether fulfillment is enabled for the specific feature. @@ -462,7 +467,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # Optional. The password for HTTP Basic authentication. "requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -470,7 +475,7 @@

Method Details

"uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. "username": "A String", # Optional. The user name for HTTP Basic authentication. }, - "name": "A String", # Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. }
diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html index b7b4b5d34ae..a44b4b4c8fa 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html @@ -189,7 +189,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.versions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.versions.html new file mode 100644 index 00000000000..f5cad50db4b --- /dev/null +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.versions.html @@ -0,0 +1,258 @@ + + + +

Dialogflow API . projects . locations . agent . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an agent version. The new version points to the agent instance in the "default" environment.

+

+ delete(name, x__xgafv=None)

+

Delete the specified agent version.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent version.

+

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

+

Returns the list of all versions of the specified agent.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an agent version. The new version points to the agent instance in the "default" environment.
+
+Args:
+  parent: string, Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete the specified agent version.
+
+Args:
+  name: string, Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent version.
+
+Args:
+  name: string, Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all versions of the specified agent.
+
+Args:
+  parent: string, Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Versions.ListVersions.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "versions": [ # The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request.
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+      "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+      "description": "A String", # Optional. The developer-provided description of this version.
+      "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+      "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+      "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
+
+Args:
+  name: string, Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index 751f37118fa..9bfc147a997 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -121,7 +121,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -161,7 +161,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -255,7 +255,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -295,7 +295,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -414,7 +414,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -454,7 +454,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -559,7 +559,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -599,7 +599,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -712,7 +712,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -752,7 +752,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -847,7 +847,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -887,7 +887,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index ea96b95e4e7..30f135f012f 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -128,7 +128,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.html b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.html index 681d47b94ad..1eac35f948f 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.html @@ -87,18 +87,269 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates an agent environment.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified agent environment.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent environment.

+

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

+

Gets the history of the specified environment.

+

+ getHistory_next(previous_request, previous_response)

+

Retrieves the next page of results.

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

Returns the list of all non-draft environments of the specified agent.

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, environmentId=None, x__xgafv=None) +
Creates an agent environment.
+
+Args:
+  parent: string, Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  environmentId: string, Required. The unique id of the new environment.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ getHistory(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets the history of the specified environment.
+
+Args:
+  parent: string, Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Environments.GetEnvironmentHistory.
+  "entries": [ # Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.
+    { # Represents an environment history entry.
+      "agentVersion": "A String", # The agent version loaded into this environment history entry.
+      "createTime": "A String", # The creation time of this environment history entry.
+      "description": "A String", # The developer-provided description for this environment history entry.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "parent": "A String", # Output only. The name of the environment this history is for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+}
+
+ +
+ getHistory_next(previous_request, previous_response) +
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(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all non-draft environments of the specified agent.
@@ -120,8 +371,46 @@ 

Method Details

{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. + "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment. + "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. + "enabled": True or False, # Whether fulfillment is enabled. + "features": [ # The field defines whether the fulfillment is enabled for certain features. + { # Whether fulfillment is enabled for the specific feature. + "type": "A String", # The type of the feature that enabled for fulfillment. + }, + ], + "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. + "password": "A String", # The password for HTTP Basic authentication. + "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. + "a_key": "A String", + }, + "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. + "username": "A String", # The user name for HTTP Basic authentication. + }, + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. + }, "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment. + "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained. + "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. + "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). + "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig. + "a_key": { # Configuration of how speech should be synthesized. + "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. + "A String", + ], + "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. + "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. + "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. + "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). + "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. + }, + "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. + }, + }, + }, "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. }, ], @@ -143,4 +432,116 @@

Method Details

+
+ patch(name, allowLoadToDraftAndDiscardChanges=None, body=None, updateMask=None, x__xgafv=None) +
Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.
+
+Args:
+  name: string, Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  allowLoadToDraftAndDiscardChanges: boolean, Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html index a6cd929097c..ecec522da29 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html @@ -194,7 +194,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.html b/docs/dyn/dialogflow_v2beta1.projects.agent.html index de95639db94..18bf4e30f54 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.html @@ -99,6 +99,11 @@

Instance Methods

Returns the sessions Resource.

+

+ versions() +

+

Returns the versions Resource.

+

close()

Close httplib2 connections.

@@ -200,7 +205,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # The password for HTTP Basic authentication. "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -438,7 +443,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # The password for HTTP Basic authentication. "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -467,7 +472,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # The password for HTTP Basic authentication. "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. "a_key": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html index b41b0cd554c..a2c3ef3ed74 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html @@ -194,7 +194,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.versions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.versions.html new file mode 100644 index 00000000000..6124d1288ec --- /dev/null +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.versions.html @@ -0,0 +1,258 @@ + + + +

Dialogflow API . projects . agent . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an agent version. The new version points to the agent instance in the "default" environment.

+

+ delete(name, x__xgafv=None)

+

Delete the specified agent version.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent version.

+

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

+

Returns the list of all versions of the specified agent.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an agent version. The new version points to the agent instance in the "default" environment.
+
+Args:
+  parent: string, Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete the specified agent version.
+
+Args:
+  name: string, Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent version.
+
+Args:
+  name: string, Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all versions of the specified agent.
+
+Args:
+  parent: string, Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Versions.ListVersions.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "versions": [ # The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request.
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+      "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+      "description": "A String", # Optional. The developer-provided description of this version.
+      "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+      "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+      "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
+
+Args:
+  name: string, Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index 2f883b591d8..c9946d88797 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -121,7 +121,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -161,7 +161,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -255,7 +255,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -295,7 +295,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -414,7 +414,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -454,7 +454,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -559,7 +559,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -599,7 +599,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -712,7 +712,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -752,7 +752,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -847,7 +847,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -887,7 +887,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 60a8b3cbb7a..cbc9648ab2b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -129,7 +129,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.html index 4c54d2ca5fd..5a229a3e942 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.html @@ -82,18 +82,269 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates an agent environment.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified agent environment.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent environment.

+

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

+

Gets the history of the specified environment.

+

+ getHistory_next(previous_request, previous_response)

+

Retrieves the next page of results.

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

Returns the list of all non-draft environments of the specified agent.

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, environmentId=None, x__xgafv=None) +
Creates an agent environment.
+
+Args:
+  parent: string, Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  environmentId: string, Required. The unique id of the new environment.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent environment.
+
+Args:
+  name: string, Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ +
+ getHistory(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets the history of the specified environment.
+
+Args:
+  parent: string, Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Environments.GetEnvironmentHistory.
+  "entries": [ # Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.
+    { # Represents an environment history entry.
+      "agentVersion": "A String", # The agent version loaded into this environment history entry.
+      "createTime": "A String", # The creation time of this environment history entry.
+      "description": "A String", # The developer-provided description for this environment history entry.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "parent": "A String", # Output only. The name of the environment this history is for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+}
+
+ +
+ getHistory_next(previous_request, previous_response) +
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(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all non-draft environments of the specified agent.
@@ -115,8 +366,46 @@ 

Method Details

{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. + "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment. + "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. + "enabled": True or False, # Whether fulfillment is enabled. + "features": [ # The field defines whether the fulfillment is enabled for certain features. + { # Whether fulfillment is enabled for the specific feature. + "type": "A String", # The type of the feature that enabled for fulfillment. + }, + ], + "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. + "password": "A String", # The password for HTTP Basic authentication. + "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. + "a_key": "A String", + }, + "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. + "username": "A String", # The user name for HTTP Basic authentication. + }, + "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. + }, "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment. + "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained. + "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. + "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). + "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig. + "a_key": { # Configuration of how speech should be synthesized. + "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. + "A String", + ], + "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. + "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. + "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. + "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). + "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. + }, + "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. + }, + }, + }, "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. }, ], @@ -138,4 +427,116 @@

Method Details

+
+ patch(name, allowLoadToDraftAndDiscardChanges=None, body=None, updateMask=None, x__xgafv=None) +
Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use "-" as Environment ID in environment name to update version in "draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.
+
+Args:
+  name: string, Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+  allowLoadToDraftAndDiscardChanges: boolean, Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "agentVersion": "A String", # Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "description": "A String", # Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+  "fulfillment": { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). # Optional. The fulfillment settings to use for this environment.
+    "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
+    "enabled": True or False, # Whether fulfillment is enabled.
+    "features": [ # The field defines whether the fulfillment is enabled for certain features.
+      { # Whether fulfillment is enabled for the specific feature.
+        "type": "A String", # The type of the feature that enabled for fulfillment.
+      },
+    ],
+    "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
+      "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
+      "password": "A String", # The password for HTTP Basic authentication.
+      "requestHeaders": { # The HTTP request headers to send together with fulfillment requests.
+        "a_key": "A String",
+      },
+      "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
+      "username": "A String", # The user name for HTTP Basic authentication.
+    },
+    "name": "A String", # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
+  },
+  "name": "A String", # Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`
+  "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+  "textToSpeechSettings": { # Instructs the speech synthesizer on how to generate the output audio content. # Optional. Text to speech settings for this environment.
+    "enableTextToSpeech": True or False, # Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
+    "outputAudioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
+    "synthesizeSpeechConfigs": { # Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
+      "a_key": { # Configuration of how speech should be synthesized.
+        "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
+          "A String",
+        ],
+        "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
+        "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
+        "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+          "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+          "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
+        },
+        "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html index 30ad96dd375..3a8ab0d22dc 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html @@ -194,7 +194,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.html index 30a1b572fcc..2fd9246b056 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.html @@ -94,6 +94,11 @@

Instance Methods

Returns the sessions Resource.

+

+ versions() +

+

Returns the versions Resource.

+

close()

Close httplib2 connections.

@@ -195,7 +200,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # The password for HTTP Basic authentication. "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -433,7 +438,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # The password for HTTP Basic authentication. "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. "a_key": "A String", @@ -462,7 +467,7 @@

Method Details

}, ], "genericWebService": { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service. - "isCloudFunction": True or False, # Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + "isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. "password": "A String", # The password for HTTP Basic authentication. "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. "a_key": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html index b17b9eebc28..83b3403c006 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html @@ -194,7 +194,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.versions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.versions.html new file mode 100644 index 00000000000..948d9cd8f9b --- /dev/null +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.versions.html @@ -0,0 +1,258 @@ + + + +

Dialogflow API . projects . locations . agent . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an agent version. The new version points to the agent instance in the "default" environment.

+

+ delete(name, x__xgafv=None)

+

Delete the specified agent version.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified agent version.

+

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

+

Returns the list of all versions of the specified agent.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an agent version. The new version points to the agent instance in the "default" environment.
+
+Args:
+  parent: string, Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete the specified agent version.
+
+Args:
+  name: string, Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified agent version.
+
+Args:
+  name: string, Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all versions of the specified agent.
+
+Args:
+  parent: string, Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent` (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Versions.ListVersions.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "versions": [ # The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request.
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+      "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+      "description": "A String", # Optional. The developer-provided description of this version.
+      "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+      "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+      "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
+
+Args:
+  name: string, Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+  updateMask: string, Required. The mask to control which fields get updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).
+  "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.
+  "description": "A String", # Optional. The developer-provided description of this version.
+  "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`
+  "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods.
+  "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index 84a003f0772..b46ae42c8e2 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -121,7 +121,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -161,7 +161,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -255,7 +255,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -295,7 +295,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -414,7 +414,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -454,7 +454,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -559,7 +559,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -599,7 +599,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -712,7 +712,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -752,7 +752,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -847,7 +847,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. @@ -887,7 +887,7 @@

Method Details

"featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY. # Configs of custom conversation model. - "model": "A String", # Required. Conversation model resource name. Format: `projects//conversationModels/`. + "model": "A String", # Conversation model resource name. Format: `projects//conversationModels/`. }, "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST. "queryConfig": { # Config for suggestion query. # Configs of query. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 9606d4804fc..ad6d2012e7d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -129,7 +129,7 @@

Method Details

}, }, ], - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html index 46dff20e5c3..8f47a909c04 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -157,14 +157,14 @@

Method Details

"analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -805,10 +805,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -840,10 +840,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -964,10 +964,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1034,14 +1034,14 @@

Method Details

"analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -1699,10 +1699,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1734,10 +1734,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1888,14 +1888,14 @@

Method Details

"analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -2519,10 +2519,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html index 84b4ae060fb..1e10d9c692e 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html @@ -98,12 +98,18 @@

Instance Methods

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

Deletes a specified flow.

+

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

+

Exports the specified flow to a binary file. Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

get(name, languageCode=None, x__xgafv=None)

Retrieves the specified flow.

getValidationResult(name, languageCode=None, x__xgafv=None)

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

+

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

+

Imports the specified flow to the specified agent from a binary file.

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

Returns the list of all flows in the specified agent.

@@ -381,7 +387,7 @@

Method Details

], } - languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -657,13 +663,56 @@

Method Details

} +
+ export(name, body=None, x__xgafv=None) +
Exports the specified flow to a binary file. Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
+
+Args:
+  name: string, Required. The name of the flow to export. Format: `projects//locations//agents//flows/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Flows.ExportFlow.
+  "flowUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the flow to. The format of this URI must be `gs:///`. If left unspecified, the serialized flow is returned inline.
+  "includeReferencedFlows": True or False, # Optional. Whether to export flows referenced by the specified flow.
+}
+
+  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.
+  },
+}
+
+
get(name, languageCode=None, x__xgafv=None)
Retrieves the specified flow.
 
 Args:
   name: string, Required. The name of the flow to get. Format: `projects//locations//agents//flows/`. (required)
-  languageCode: string, The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
+  languageCode: string, The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -957,13 +1006,57 @@ 

Method Details

}
+
+ import_(parent, body=None, x__xgafv=None) +
Imports the specified flow to the specified agent from a binary file.
+
+Args:
+  parent: string, Required. The agent to import the flow into. Format: `projects//locations//agents/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Flows.ImportFlow.
+  "flowContent": "A String", # Uncompressed raw byte content for flow.
+  "flowUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import flow from. The format of this URI must be `gs:///`.
+  "importOption": "A String", # Flow import mode. If not specified, `KEEP` is assumed.
+}
+
+  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.
+  },
+}
+
+
list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all flows in the specified agent.
 
 Args:
   parent: string, Required. The agent containing the flows. Format: `projects//locations//agents/`. (required)
-  languageCode: string, The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
+  languageCode: string, The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
   pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
   pageToken: string, The next_page_token value returned from a previous list request.
   x__xgafv: string, V1 error format.
@@ -1497,7 +1590,7 @@ 

Method Details

], } - languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. updateMask: string, Required. The mask to control which fields get updated. If `update_mask` is not specified, an error will be returned. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html index 4bf5359a332..454bd193c3d 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html @@ -697,7 +697,7 @@

Method Details

], } - languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1319,7 +1319,7 @@

Method Details

Args: name: string, Required. The name of the page. Format: `projects//locations//agents//flows//pages/`. (required) - languageCode: string, The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1922,7 +1922,7 @@

Method Details

Args: parent: string, Required. The flow to list all pages for. Format: `projects//locations//agents//flows/`. (required) - languageCode: string, The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. pageToken: string, The next_page_token value returned from a previous list request. x__xgafv: string, V1 error format. @@ -3136,7 +3136,7 @@

Method Details

], } - languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html index 7c4c3ea6476..9cc36c0dfd8 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html @@ -232,7 +232,7 @@

Method Details

], } - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -389,7 +389,7 @@

Method Details

Args: name: string, Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/`. (required) - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -527,7 +527,7 @@

Method Details

Args: parent: string, Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/`. (required) - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. pageToken: string, The next_page_token value returned from a previous list request. x__xgafv: string, V1 error format. @@ -811,7 +811,7 @@

Method Details

], } - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. updateMask: string, The mask to control which fields get updated. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html index 48e56c0d6f9..a68f0b12533 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html @@ -94,7 +94,7 @@

Instance Methods

Retrieves the next page of results.

load(name, body=None, x__xgafv=None)

-

Loads a specified version to draft version.

+

Loads resources in the specified version to the draft flow.

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

Updates the specified Version.

@@ -252,15 +252,15 @@

Method Details

load(name, body=None, x__xgafv=None) -
Loads a specified version to draft version.
+  
Loads resources in the specified version to the draft flow.
 
 Args:
-  name: string, Required. The Version to be loaded to draft version. Format: `projects//locations//agents//flows//versions/`. (required)
+  name: string, Required. The Version to be loaded to draft flow. Format: `projects//locations//agents//flows//versions/`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # The request message for Versions.LoadVersion.
-  "allowOverrideAgentResources": True or False, # This field is used to prevent accidental overwrite of other agent resources in the draft version, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).
+  "allowOverrideAgentResources": True or False, # This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.html b/docs/dyn/dialogflow_v3.projects.locations.agents.html
index de28ca1cb8e..b7bc010ce30 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.agents.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.agents.html
@@ -170,6 +170,9 @@ 

Method Details

"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). + "A String", + ], "timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. } @@ -194,6 +197,9 @@

Method Details

"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). + "A String", + ], "timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. }
@@ -227,6 +233,7 @@

Method Details

{ # The request message for Agents.ExportAgent. "agentUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline. + "environment": "A String", # Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`. } x__xgafv: string, V1 error format. @@ -285,6 +292,9 @@

Method Details

"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). + "A String", + ], "timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. }
@@ -362,6 +372,9 @@

Method Details

"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). + "A String", + ], "timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. }, ], @@ -405,6 +418,9 @@

Method Details

"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). + "A String", + ], "timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. } @@ -430,6 +446,9 @@

Method Details

"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). + "A String", + ], "timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. } diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.intents.html b/docs/dyn/dialogflow_v3.projects.locations.agents.intents.html index 236d5d7aa0e..e28df4200ad 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.intents.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.intents.html @@ -111,10 +111,10 @@

Method Details

The object takes the form of: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -151,10 +151,10 @@

Method Details

An object of the form: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -216,10 +216,10 @@

Method Details

An object of the form: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -272,10 +272,10 @@

Method Details

{ # The response message for Intents.ListIntents. "intents": [ # The list of intents. There will be a maximum number of items returned based on the page_size field in the request. { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -330,10 +330,10 @@

Method Details

The object takes the form of: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -371,10 +371,10 @@

Method Details

An object of the form: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index ac5e3c6e7cc..a536cf2a608 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -157,14 +157,14 @@

Method Details

"analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -805,10 +805,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -840,10 +840,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -964,10 +964,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1034,14 +1034,14 @@

Method Details

"analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -1699,10 +1699,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1734,10 +1734,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1888,14 +1888,14 @@

Method Details

"analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "geoLocation": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. + "geoLocation": { # 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. # The geo location of this conversational query. "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]. }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -2519,10 +2519,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html index 9af262d2d9e..abfeea0a271 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html @@ -3050,10 +3050,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -3747,10 +3747,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -4454,10 +4454,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -5151,10 +5151,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -5909,10 +5909,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -6606,10 +6606,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -7373,10 +7373,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -8070,10 +8070,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -8795,10 +8795,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -9492,10 +9492,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -10200,10 +10200,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -10897,10 +10897,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html index 01387f6550a..4befb9e543d 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html @@ -762,10 +762,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1477,10 +1477,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys." is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. "sys.head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html index ecb7283bd87..7ff4b740fb1 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -805,10 +805,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -840,10 +840,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -964,10 +964,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1699,10 +1699,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1734,10 +1734,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -2519,10 +2519,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html index f1962e4552c..56344240ac2 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html @@ -381,7 +381,7 @@

Method Details

], } - languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -663,7 +663,7 @@

Method Details

Args: name: string, Required. The name of the flow to get. Format: `projects//locations//agents//flows/`. (required) - languageCode: string, The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -963,7 +963,7 @@

Method Details

Args: parent: string, Required. The agent containing the flows. Format: `projects//locations//agents/`. (required) - languageCode: string, The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. pageToken: string, The next_page_token value returned from a previous list request. x__xgafv: string, V1 error format. @@ -1497,7 +1497,7 @@

Method Details

], } - languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. updateMask: string, Required. The mask to control which fields get updated. If `update_mask` is not specified, an error will be returned. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html index ec75126ed09..bf1afba6594 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html @@ -697,7 +697,7 @@

Method Details

], } - languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1319,7 +1319,7 @@

Method Details

Args: name: string, Required. The name of the page. Format: `projects//locations//agents//flows//pages/`. (required) - languageCode: string, The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1922,7 +1922,7 @@

Method Details

Args: parent: string, Required. The flow to list all pages for. Format: `projects//locations//agents//flows/`. (required) - languageCode: string, The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. pageToken: string, The next_page_token value returned from a previous list request. x__xgafv: string, V1 error format. @@ -3136,7 +3136,7 @@

Method Details

], } - languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html index b821241617e..7f0b5333992 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html @@ -232,7 +232,7 @@

Method Details

], } - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -389,7 +389,7 @@

Method Details

Args: name: string, Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/`. (required) - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -527,7 +527,7 @@

Method Details

Args: parent: string, Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/`. (required) - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. pageToken: string, The next_page_token value returned from a previous list request. x__xgafv: string, V1 error format. @@ -811,7 +811,7 @@

Method Details

], } - languageCode: string, The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + languageCode: string, The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. updateMask: string, The mask to control which fields get updated. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html index 11744e90920..25176de3c8a 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html @@ -94,7 +94,7 @@

Instance Methods

Retrieves the next page of results.

load(name, body=None, x__xgafv=None)

-

Loads a specified version to draft version.

+

Loads resources in the specified version to the draft flow.

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

Updates the specified Version.

@@ -252,15 +252,15 @@

Method Details

load(name, body=None, x__xgafv=None) -
Loads a specified version to draft version.
+  
Loads resources in the specified version to the draft flow.
 
 Args:
-  name: string, Required. The Version to be loaded to draft version. Format: `projects//locations//agents//flows//versions/`. (required)
+  name: string, Required. The Version to be loaded to draft flow. Format: `projects//locations//agents//flows//versions/`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # The request message for Versions.LoadVersion.
-  "allowOverrideAgentResources": True or False, # This field is used to prevent accidental overwrite of other agent resources in the draft version, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).
+  "allowOverrideAgentResources": True or False, # This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.intents.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.intents.html
index 16c54029cda..d45589af028 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.intents.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.intents.html
@@ -111,10 +111,10 @@ 

Method Details

The object takes the form of: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -151,10 +151,10 @@

Method Details

An object of the form: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -216,10 +216,10 @@

Method Details

An object of the form: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -272,10 +272,10 @@

Method Details

{ # The response message for Intents.ListIntents. "intents": [ # The list of intents. There will be a maximum number of items returned based on the page_size field in the request. { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -330,10 +330,10 @@

Method Details

The object takes the form of: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -371,10 +371,10 @@

Method Details

An object of the form: { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index 38c71e2e21f..abf314e5667 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -805,10 +805,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -840,10 +840,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -964,10 +964,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1699,10 +1699,10 @@

Method Details

"a_key": "", # Properties of the object. }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1734,10 +1734,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -2519,10 +2519,10 @@

Method Details

"confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html index cbba43afdaa..4c92d967c37 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html @@ -3050,10 +3050,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -3747,10 +3747,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -4454,10 +4454,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -5151,10 +5151,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -5909,10 +5909,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -6606,10 +6606,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -7373,10 +7373,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -8070,10 +8070,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -8795,10 +8795,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -9492,10 +9492,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -10200,10 +10200,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -10897,10 +10897,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html index 8d8e082d729..b6e9a60cea7 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html @@ -762,10 +762,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. @@ -1477,10 +1477,10 @@

Method Details

}, ], "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. - "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. "a_key": "A String", }, "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. diff --git a/docs/dyn/displayvideo_v1.advertisers.channels.html b/docs/dyn/displayvideo_v1.advertisers.channels.html index ef5af20eef4..d4aaf7641de 100644 --- a/docs/dyn/displayvideo_v1.advertisers.channels.html +++ b/docs/dyn/displayvideo_v1.advertisers.channels.html @@ -117,7 +117,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } partnerId: string, The ID of the partner that owns the created channel. @@ -134,7 +136,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. }
@@ -159,7 +163,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } @@ -189,7 +195,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results. @@ -225,7 +233,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } partnerId: string, The ID of the partner that owns the created channel. @@ -243,7 +253,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } diff --git a/docs/dyn/displayvideo_v1.advertisers.html b/docs/dyn/displayvideo_v1.advertisers.html index 0845d9c9724..78cc68cb85a 100644 --- a/docs/dyn/displayvideo_v1.advertisers.html +++ b/docs/dyn/displayvideo_v1.advertisers.html @@ -1097,7 +1097,7 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com @@ -1156,7 +1156,7 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com @@ -1240,7 +1240,7 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com @@ -1312,7 +1312,7 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com @@ -1390,7 +1390,7 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com @@ -1450,7 +1450,7 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com diff --git a/docs/dyn/displayvideo_v1.advertisers.lineItems.html b/docs/dyn/displayvideo_v1.advertisers.lineItems.html index 85c6f3bcdb6..7957e919d90 100644 --- a/docs/dyn/displayvideo_v1.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v1.advertisers.lineItems.html @@ -1503,7 +1503,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser to list line items for. (required) - filter: string, Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * The operator can be `NO LESS THAN (>=)` or `NO GREATER THAN (<=)`. - `updateTime` (format of ISO 8601) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:"NO_VALID_CREATIVE"` * All line items with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. + filter: string, Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported properties: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - `targetedChannelId` - `targetedNegativeKeywordListId` Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:"NO_VALID_CREATIVE"` * All line items with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-04T18:54:47Z"` * All line items that are using both the specified channel and specified negative keyword list in their targeting: `targetedNegativeKeywordListId=789 AND targetedChannelId=12345` The length of this field should be no more than 500 characters. orderBy: string, Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * “flight.dateRange.endDate” * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. diff --git a/docs/dyn/displayvideo_v1.advertisers.negativeKeywordLists.html b/docs/dyn/displayvideo_v1.advertisers.negativeKeywordLists.html index d728787879f..177d203cb90 100644 --- a/docs/dyn/displayvideo_v1.advertisers.negativeKeywordLists.html +++ b/docs/dyn/displayvideo_v1.advertisers.negativeKeywordLists.html @@ -120,6 +120,7 @@

Method Details

"displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. "name": "A String", # Output only. The resource name of the negative keyword list. "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. + "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. } x__xgafv: string, V1 error format. @@ -135,6 +136,7 @@

Method Details

"displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. "name": "A String", # Output only. The resource name of the negative keyword list. "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. + "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. } @@ -177,6 +179,7 @@

Method Details

"displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. "name": "A String", # Output only. The resource name of the negative keyword list. "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. + "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. } @@ -203,6 +206,7 @@

Method Details

"displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. "name": "A String", # Output only. The resource name of the negative keyword list. "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. + "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results. @@ -238,6 +242,7 @@

Method Details

"displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. "name": "A String", # Output only. The resource name of the negative keyword list. "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. + "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. } updateMask: string, Required. The mask to control which fields to update. @@ -254,6 +259,7 @@

Method Details

"displayName": "A String", # Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. "name": "A String", # Output only. The resource name of the negative keyword list. "negativeKeywordListId": "A String", # Output only. The unique ID of the negative keyword list. Assigned by the system. + "targetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this negative keyword list. } diff --git a/docs/dyn/displayvideo_v1.partners.channels.html b/docs/dyn/displayvideo_v1.partners.channels.html index 99055779e7d..400aef84e60 100644 --- a/docs/dyn/displayvideo_v1.partners.channels.html +++ b/docs/dyn/displayvideo_v1.partners.channels.html @@ -117,7 +117,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } advertiserId: string, The ID of the advertiser that owns the created channel. @@ -134,7 +136,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } @@ -159,7 +163,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } @@ -189,7 +195,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results. @@ -225,7 +233,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } advertiserId: string, The ID of the advertiser that owns the created channel. @@ -243,7 +253,9 @@

Method Details

"channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system. "displayName": "A String", # Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. "name": "A String", # Output only. The resource name of the channel. + "negativelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel negatively. "partnerId": "A String", # The ID of the partner that owns the channel. + "positivelyTargetedLineItemCount": "A String", # Output only. Number of line items that are directly targeting this channel positively. } diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 2589b65bd57..3eff83cbe51 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -1016,7 +1016,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -1067,7 +1067,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -2025,7 +2025,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -2343,7 +2343,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -3171,7 +3171,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 63f23e93262..5e4b96fa3f5 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -1016,7 +1016,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -1067,7 +1067,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -2025,7 +2025,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -2343,7 +2343,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -3171,7 +3171,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index ef5bc852ed7..87a7fffdf51 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -2497,7 +2497,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index b15dc468b0d..6731e29e92a 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -1969,7 +1969,7 @@

Method Details

"data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. diff --git a/docs/dyn/documentai_v1.projects.locations.html b/docs/dyn/documentai_v1.projects.locations.html index 6dd787e582f..8cd33534d20 100644 --- a/docs/dyn/documentai_v1.projects.locations.html +++ b/docs/dyn/documentai_v1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/documentai_v1.uiv1beta3.projects.locations.html b/docs/dyn/documentai_v1.uiv1beta3.projects.locations.html index 08ad38453f7..6031c1c4b49 100644 --- a/docs/dyn/documentai_v1.uiv1beta3.projects.locations.html +++ b/docs/dyn/documentai_v1.uiv1beta3.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/documentai_v1beta3.projects.locations.html b/docs/dyn/documentai_v1beta3.projects.locations.html index 33fd958adf6..d34c57d68ad 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.html @@ -87,6 +87,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ fetchProcessorTypes(parent, x__xgafv=None)

+

Fetches processor types.

get(name, x__xgafv=None)

Gets information about a location.

@@ -102,6 +105,56 @@

Method Details

Close httplib2 connections.
+
+ fetchProcessorTypes(parent, x__xgafv=None) +
Fetches processor types.
+
+Args:
+  parent: string, Required. The project of processor type to list. The available processor types may depend on the whitelisting on projects. Format: projects/{project}/locations/{location} (required)
+  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 fetch processor types.
+  "processorTypes": [ # The list of processor types.
+    { # A processor type is responsible for performing a certain document understanding task on a certain type of document. All processor types are created by the documentai service internally. User will only list all available processor types via UI. For different users (projects), the available processor types may be different since we'll expose the access of some types via EAP whitelisting. We make the ProcessorType a resource under location so we have a unified API and keep the possibility that UI will load different available processor types from different regions. But for alpha the behavior is that the user will always get the union of all available processor types among all regions no matter which regionalized endpoint is called, and then we use the 'available_locations' field to show under which regions a processor type is available. For example, users can call either the 'US' or 'EU' endpoint to feach processor types. In the return, we will have an 'invoice parsing' processor with 'available_locations' field only containing 'US'. So the user can try to create an 'invoice parsing' processor under the location 'US'. Such attempt of creating under the location 'EU' will fail. Next ID: 7.
+      "allowCreation": True or False, # Whether the processor type allows creation. If yes, user can create a processor of this processor type. Otherwise, user needs to require for whitelisting.
+      "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.
+      "name": "A String", # The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}
+      "schema": { # The schema defines the output of the processed document by a processor. # The schema of the default version of this processor type.
+        "description": "A String", # Description of the schema.
+        "displayName": "A String", # Display name to show to users.
+        "entityTypes": [ # Entity types of the schema.
+          { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+            "baseType": "A String", # Type of the entity. It must be one of the following: `document` - the entity represents a classification of a logical document. `object` - if the entity has properties it is likely an object (or or a document.) `datetime` - the entity is a date or time value. `money` - the entity represents a money value amount. `number` - the entity is a number - integer or floating point. `string` - the entity is a string value. `boolean` - the entity is a boolean value. `address` - the entity is a location address.
+            "description": "A String", # Description of the entity type.
+            "enumValues": [ # For some entity types there are only a few possible values. They can be specified here.
+              "A String",
+            ],
+            "occurrenceType": "A String", # Occurrence type limits the number of times an entity type appears in the document.
+            "properties": [ # Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType 'ID', which consists of EntityType 'name' and 'address', with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.
+              # Object with schema name: GoogleCloudDocumentaiV1beta3SchemaEntityType
+            ],
+            "source": "A String", # Source of this entity type.
+            "type": "A String", # Name of the type. It must be unique within the set of same level types.
+          },
+        ],
+      },
+      "type": "A String", # The type of the processor, e.g, "invoice_parsing".
+    },
+  ],
+}
+
+
get(name, x__xgafv=None)
Gets information about a location.
@@ -136,7 +189,7 @@ 

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 5356193dae8..703a0bb2849 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -90,6 +90,24 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

+

+ delete(name, x__xgafv=None)

+

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

+

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

+

Disables a processor

+

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

+

Enables a processor

+

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

+

Lists all processors which belong to this project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

process(name, body=None, x__xgafv=None)

Processes a single document.

@@ -168,6 +186,210 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
+
+Args:
+  parent: string, Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
+  "createTime": "A String", # The time the processor was created.
+  "defaultProcessorVersion": "A String", # The default processor version.
+  "displayName": "A String", # The display name of the processor.
+  "kmsKeyName": "A String", # The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
+  "name": "A String", # Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
+  "processEndpoint": "A String", # Output only. Immutable. The http endpoint that can be called to invoke processing.
+  "state": "A String", # Output only. The state of the processor.
+  "type": "A String", # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
+  "createTime": "A String", # The time the processor was created.
+  "defaultProcessorVersion": "A String", # The default processor version.
+  "displayName": "A String", # The display name of the processor.
+  "kmsKeyName": "A String", # The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
+  "name": "A String", # Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
+  "processEndpoint": "A String", # Output only. Immutable. The http endpoint that can be called to invoke processing.
+  "state": "A String", # Output only. The state of the processor.
+  "type": "A String", # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
+
+Args:
+  name: string, Required. The processor resource name to 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.
+  },
+}
+
+ +
+ disable(name, body=None, x__xgafv=None) +
Disables a processor
+
+Args:
+  name: string, Required. The processor resource name to be disabled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the disable processor method.
+}
+
+  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.
+  },
+}
+
+ +
+ enable(name, body=None, x__xgafv=None) +
Enables a processor
+
+Args:
+  name: string, Required. The processor resource name to be enabled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the enable processor method.
+}
+
+  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.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all processors which belong to this project.
+
+Args:
+  parent: string, Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location} (required)
+  pageSize: integer, The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, We will return the processors sorted by creation time. The page token will point to the next processor.
+  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 processors.
+  "nextPageToken": "A String", # Points to the next processor, otherwise empty.
+  "processors": [ # The list of processors.
+    { # The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
+      "createTime": "A String", # The time the processor was created.
+      "defaultProcessorVersion": "A String", # The default processor version.
+      "displayName": "A String", # The display name of the processor.
+      "kmsKeyName": "A String", # The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
+      "name": "A String", # Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
+      "processEndpoint": "A String", # Output only. Immutable. The http endpoint that can be called to invoke processing.
+      "state": "A String", # Output only. The state of the processor.
+      "type": "A String", # The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
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.
+    
+
+
process(name, body=None, x__xgafv=None)
Processes a single document.
diff --git a/docs/dyn/domains_v1alpha2.projects.locations.html b/docs/dyn/domains_v1alpha2.projects.locations.html
index bb3619c7b42..7381663636b 100644
--- a/docs/dyn/domains_v1alpha2.projects.locations.html
+++ b/docs/dyn/domains_v1alpha2.projects.locations.html
@@ -135,9 +135,9 @@ 

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - filter: string, The standard list filter. - pageSize: integer, The standard list page size. - pageToken: string, The standard list page token. + filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. + pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/domains_v1beta1.projects.locations.html b/docs/dyn/domains_v1beta1.projects.locations.html index aa3902da251..5561b43eba5 100644 --- a/docs/dyn/domains_v1beta1.projects.locations.html +++ b/docs/dyn/domains_v1beta1.projects.locations.html @@ -135,9 +135,9 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - filter: string, The standard list filter. - pageSize: integer, The standard list page size. - pageToken: string, The standard list page token. + filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. + pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/drive_v2.comments.html b/docs/dyn/drive_v2.comments.html index 0a1358117c6..58d5cb8e3c6 100644 --- a/docs/dyn/drive_v2.comments.html +++ b/docs/dyn/drive_v2.comments.html @@ -127,7 +127,7 @@

Method Details

An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. @@ -192,7 +192,7 @@

Method Details

The object takes the form of: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. @@ -251,7 +251,7 @@

Method Details

An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. @@ -323,7 +323,7 @@

Method Details

{ # A list of comments on a file in Google Drive. "items": [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. @@ -409,7 +409,7 @@

Method Details

The object takes the form of: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. @@ -468,7 +468,7 @@

Method Details

An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. @@ -534,7 +534,7 @@

Method Details

The object takes the form of: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. @@ -593,7 +593,7 @@

Method Details

An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index 89cf8955b3c..da1ba44ef58 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -97,10 +97,10 @@

Instance Methods

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)

-

Gets a file's metadata by ID.

+

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)

-

Gets a file's metadata by ID.

+

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 a new file.

@@ -962,7 +962,7 @@

Method Details

get(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None) -
Gets a file's metadata by ID.
+  
Gets a file's metadata or content by ID.
 
 Args:
   fileId: string, The ID for the file in question. (required)
@@ -1350,7 +1350,7 @@ 

Method Details

get_media(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None) -
Gets a file's metadata by ID.
+  
Gets a file's metadata or content by ID.
 
 Args:
   fileId: string, The ID for the file in question. (required)
diff --git a/docs/dyn/drive_v3.comments.html b/docs/dyn/drive_v3.comments.html
index 77c60f60d37..28a3356a192 100644
--- a/docs/dyn/drive_v3.comments.html
+++ b/docs/dyn/drive_v3.comments.html
@@ -111,7 +111,7 @@ 

Method Details

The object takes the form of: { # A comment on a file. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "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. @@ -161,7 +161,7 @@

Method Details

An object of the form: { # A comment on a file. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "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. @@ -230,7 +230,7 @@

Method Details

An object of the form: { # A comment on a file. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "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. @@ -293,7 +293,7 @@

Method Details

{ # A list of comments on a file. "comments": [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # A comment on a file. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "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. @@ -368,7 +368,7 @@

Method Details

The object takes the form of: { # A comment on a file. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "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. @@ -418,7 +418,7 @@

Method Details

An object of the form: { # A comment on a file. - "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. "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. diff --git a/docs/dyn/essentialcontacts_v1.folders.contacts.html b/docs/dyn/essentialcontacts_v1.folders.contacts.html new file mode 100644 index 00000000000..0f507cbbe2d --- /dev/null +++ b/docs/dyn/essentialcontacts_v1.folders.contacts.html @@ -0,0 +1,371 @@ + + + +

Essential Contacts API . folders . contacts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

+

+ compute_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Adds a new contact for a resource.

+

+ delete(name, x__xgafv=None)

+

Deletes a contact.

+

+ get(name, x__xgafv=None)

+

Gets a single contact.

+

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

+

Lists the contacts that have been set on a resource.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates a contact. Note: A contact's email address cannot be changed.

+

+ sendTestMessage(resource, body=None, x__xgafv=None)

+

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
+
+Args:
+  parent: string, Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  notificationCategories: string, The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned. (repeated)
+    Allowed values
+      NOTIFICATION_CATEGORY_UNSPECIFIED - Notification category is unrecognized or unspecified.
+      ALL - All notifications related to the resource, including notifications pertaining to categories added in the future.
+      SUSPENSION - Notifications related to imminent account suspension.
+      SECURITY - Notifications related to security/privacy incidents, notifications, and vulnerabilities.
+      TECHNICAL - Notifications related to technical events and issues such as outages, errors, or bugs.
+      BILLING - Notifications related to billing and payments notifications, price updates, errors, or credits.
+      LEGAL - Notifications related to enforcement actions, regulatory compliance, or government notices.
+      PRODUCT_UPDATES - Notifications related to new versions, product terms updates, or deprecations.
+      TECHNICAL_INCIDENTS - Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL.
+  pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.
+  pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.
+  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 the ComputeContacts method.
+  "contacts": [ # All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
+    { # A contact that will receive notifications from Google Cloud.
+      "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+      "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+      "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+      "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+        "A String",
+      ],
+      "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+      "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.
+}
+
+ +
+ compute_next(previous_request, previous_response) +
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.
+    
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Adds a new contact for a resource.
+
+Args:
+  parent: string, Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a contact.
+
+Args:
+  name: string, Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a single contact.
+
+Args:
+  name: string, Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the contacts that have been set on a resource.
+
+Args:
+  parent: string, Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.
+  pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.
+  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 the ListContacts method.
+  "contacts": [ # The contacts for the specified resource.
+    { # A contact that will receive notifications from Google Cloud.
+      "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+      "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+      "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+      "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+        "A String",
+      ],
+      "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+      "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 a contact. Note: A contact's email address cannot be changed.
+
+Args:
+  name: string, The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+  updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ sendTestMessage(resource, body=None, x__xgafv=None) +
Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
+
+Args:
+  resource: string, Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the SendTestMessage method.
+  "contacts": [ # Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}
+    "A String",
+  ],
+  "notificationCategory": "A String", # Required. The notification category to send the test message for. All contacts must be subscribed to this category.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/essentialcontacts_v1.folders.html b/docs/dyn/essentialcontacts_v1.folders.html new file mode 100644 index 00000000000..2353ad05c89 --- /dev/null +++ b/docs/dyn/essentialcontacts_v1.folders.html @@ -0,0 +1,91 @@ + + + +

Essential Contacts API . folders

+

Instance Methods

+

+ contacts() +

+

Returns the contacts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/essentialcontacts_v1.html b/docs/dyn/essentialcontacts_v1.html new file mode 100644 index 00000000000..c759dd8b009 --- /dev/null +++ b/docs/dyn/essentialcontacts_v1.html @@ -0,0 +1,121 @@ + + + +

Essential Contacts API

+

Instance Methods

+

+ folders() +

+

Returns the folders Resource.

+ +

+ organizations() +

+

Returns the organizations Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/essentialcontacts_v1.organizations.contacts.html b/docs/dyn/essentialcontacts_v1.organizations.contacts.html new file mode 100644 index 00000000000..7305553b3c1 --- /dev/null +++ b/docs/dyn/essentialcontacts_v1.organizations.contacts.html @@ -0,0 +1,371 @@ + + + +

Essential Contacts API . organizations . contacts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

+

+ compute_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Adds a new contact for a resource.

+

+ delete(name, x__xgafv=None)

+

Deletes a contact.

+

+ get(name, x__xgafv=None)

+

Gets a single contact.

+

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

+

Lists the contacts that have been set on a resource.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates a contact. Note: A contact's email address cannot be changed.

+

+ sendTestMessage(resource, body=None, x__xgafv=None)

+

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
+
+Args:
+  parent: string, Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  notificationCategories: string, The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned. (repeated)
+    Allowed values
+      NOTIFICATION_CATEGORY_UNSPECIFIED - Notification category is unrecognized or unspecified.
+      ALL - All notifications related to the resource, including notifications pertaining to categories added in the future.
+      SUSPENSION - Notifications related to imminent account suspension.
+      SECURITY - Notifications related to security/privacy incidents, notifications, and vulnerabilities.
+      TECHNICAL - Notifications related to technical events and issues such as outages, errors, or bugs.
+      BILLING - Notifications related to billing and payments notifications, price updates, errors, or credits.
+      LEGAL - Notifications related to enforcement actions, regulatory compliance, or government notices.
+      PRODUCT_UPDATES - Notifications related to new versions, product terms updates, or deprecations.
+      TECHNICAL_INCIDENTS - Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL.
+  pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.
+  pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.
+  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 the ComputeContacts method.
+  "contacts": [ # All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
+    { # A contact that will receive notifications from Google Cloud.
+      "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+      "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+      "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+      "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+        "A String",
+      ],
+      "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+      "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.
+}
+
+ +
+ compute_next(previous_request, previous_response) +
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.
+    
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Adds a new contact for a resource.
+
+Args:
+  parent: string, Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a contact.
+
+Args:
+  name: string, Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a single contact.
+
+Args:
+  name: string, Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the contacts that have been set on a resource.
+
+Args:
+  parent: string, Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.
+  pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.
+  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 the ListContacts method.
+  "contacts": [ # The contacts for the specified resource.
+    { # A contact that will receive notifications from Google Cloud.
+      "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+      "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+      "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+      "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+        "A String",
+      ],
+      "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+      "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 a contact. Note: A contact's email address cannot be changed.
+
+Args:
+  name: string, The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+  updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ sendTestMessage(resource, body=None, x__xgafv=None) +
Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
+
+Args:
+  resource: string, Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the SendTestMessage method.
+  "contacts": [ # Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}
+    "A String",
+  ],
+  "notificationCategory": "A String", # Required. The notification category to send the test message for. All contacts must be subscribed to this category.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/essentialcontacts_v1.organizations.html b/docs/dyn/essentialcontacts_v1.organizations.html new file mode 100644 index 00000000000..c2eb9d8640b --- /dev/null +++ b/docs/dyn/essentialcontacts_v1.organizations.html @@ -0,0 +1,91 @@ + + + +

Essential Contacts API . organizations

+

Instance Methods

+

+ contacts() +

+

Returns the contacts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/essentialcontacts_v1.projects.contacts.html b/docs/dyn/essentialcontacts_v1.projects.contacts.html new file mode 100644 index 00000000000..b9aaad25f35 --- /dev/null +++ b/docs/dyn/essentialcontacts_v1.projects.contacts.html @@ -0,0 +1,371 @@ + + + +

Essential Contacts API . projects . contacts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

+

+ compute_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Adds a new contact for a resource.

+

+ delete(name, x__xgafv=None)

+

Deletes a contact.

+

+ get(name, x__xgafv=None)

+

Gets a single contact.

+

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

+

Lists the contacts that have been set on a resource.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates a contact. Note: A contact's email address cannot be changed.

+

+ sendTestMessage(resource, body=None, x__xgafv=None)

+

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
+
+Args:
+  parent: string, Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  notificationCategories: string, The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned. (repeated)
+    Allowed values
+      NOTIFICATION_CATEGORY_UNSPECIFIED - Notification category is unrecognized or unspecified.
+      ALL - All notifications related to the resource, including notifications pertaining to categories added in the future.
+      SUSPENSION - Notifications related to imminent account suspension.
+      SECURITY - Notifications related to security/privacy incidents, notifications, and vulnerabilities.
+      TECHNICAL - Notifications related to technical events and issues such as outages, errors, or bugs.
+      BILLING - Notifications related to billing and payments notifications, price updates, errors, or credits.
+      LEGAL - Notifications related to enforcement actions, regulatory compliance, or government notices.
+      PRODUCT_UPDATES - Notifications related to new versions, product terms updates, or deprecations.
+      TECHNICAL_INCIDENTS - Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL.
+  pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.
+  pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.
+  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 the ComputeContacts method.
+  "contacts": [ # All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
+    { # A contact that will receive notifications from Google Cloud.
+      "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+      "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+      "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+      "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+        "A String",
+      ],
+      "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+      "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.
+}
+
+ +
+ compute_next(previous_request, previous_response) +
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.
+    
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Adds a new contact for a resource.
+
+Args:
+  parent: string, Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a contact.
+
+Args:
+  name: string, Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a single contact.
+
+Args:
+  name: string, Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the contacts that have been set on a resource.
+
+Args:
+  parent: string, Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.
+  pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.
+  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 the ListContacts method.
+  "contacts": [ # The contacts for the specified resource.
+    { # A contact that will receive notifications from Google Cloud.
+      "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+      "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+      "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+      "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+        "A String",
+      ],
+      "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+      "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+    },
+  ],
+  "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.
+}
+
+ +
+ list_next(previous_request, previous_response) +
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 a contact. Note: A contact's email address cannot be changed.
+
+Args:
+  name: string, The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+  updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A contact that will receive notifications from Google Cloud.
+  "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account.
+  "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.
+  "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
+  "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for.
+    "A String",
+  ],
+  "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.
+  "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.
+}
+
+ +
+ sendTestMessage(resource, body=None, x__xgafv=None) +
Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
+
+Args:
+  resource: string, Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the SendTestMessage method.
+  "contacts": [ # Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}
+    "A String",
+  ],
+  "notificationCategory": "A String", # Required. The notification category to send the test message for. All contacts must be subscribed to this category.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/essentialcontacts_v1.projects.html b/docs/dyn/essentialcontacts_v1.projects.html new file mode 100644 index 00000000000..f585f2d2fb4 --- /dev/null +++ b/docs/dyn/essentialcontacts_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Essential Contacts API . projects

+

Instance Methods

+

+ contacts() +

+

Returns the contacts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/eventarc_v1.projects.locations.html b/docs/dyn/eventarc_v1.projects.locations.html index 8d49ae9c54f..2566e2002f4 100644 --- a/docs/dyn/eventarc_v1.projects.locations.html +++ b/docs/dyn/eventarc_v1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/eventarc_v1beta1.projects.locations.html b/docs/dyn/eventarc_v1beta1.projects.locations.html index 6f79a87747d..94630f1b183 100644 --- a/docs/dyn/eventarc_v1beta1.projects.locations.html +++ b/docs/dyn/eventarc_v1beta1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/file_v1.projects.locations.html b/docs/dyn/file_v1.projects.locations.html index 5f7468231ac..f4a87c88a9b 100644 --- a/docs/dyn/file_v1.projects.locations.html +++ b/docs/dyn/file_v1.projects.locations.html @@ -142,7 +142,7 @@

Method Details

name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). includeUnrevealedLocations: boolean, If true, the returned list will include locations which are not yet revealed. - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html index f9a20c2dccb..fcdcd1e1082 100644 --- a/docs/dyn/file_v1.projects.locations.instances.html +++ b/docs/dyn/file_v1.projects.locations.instances.html @@ -151,6 +151,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. @@ -273,6 +274,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. @@ -337,6 +339,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. @@ -410,6 +413,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. diff --git a/docs/dyn/file_v1beta1.projects.locations.html b/docs/dyn/file_v1beta1.projects.locations.html index c4818d0ab19..bbefebba77f 100644 --- a/docs/dyn/file_v1beta1.projects.locations.html +++ b/docs/dyn/file_v1beta1.projects.locations.html @@ -142,7 +142,7 @@

Method Details

name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). includeUnrevealedLocations: boolean, If true, the returned list will include locations which are not yet revealed. - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index 064051a6d14..61e77b220f8 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -151,6 +151,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. @@ -273,6 +274,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. @@ -337,6 +339,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. @@ -410,6 +413,7 @@

Method Details

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. }, ], + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The instance state. "statusMessage": "A String", # Output only. Additional information about the instance state, if available. "tier": "A String", # The service tier of the instance. diff --git a/docs/dyn/firestore_v1.projects.locations.html b/docs/dyn/firestore_v1.projects.locations.html index 4b4947faf05..f4c0f0c471e 100644 --- a/docs/dyn/firestore_v1.projects.locations.html +++ b/docs/dyn/firestore_v1.projects.locations.html @@ -126,7 +126,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/gameservices_v1beta.projects.locations.html b/docs/dyn/gameservices_v1beta.projects.locations.html index 619c4fa82bd..88fbc13ae97 100644 --- a/docs/dyn/gameservices_v1beta.projects.locations.html +++ b/docs/dyn/gameservices_v1beta.projects.locations.html @@ -142,7 +142,7 @@

Method Details

name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). includeUnrevealedLocations: boolean, If true, the returned list will include locations which are not yet revealed. - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/genomics_v2alpha1.pipelines.html b/docs/dyn/genomics_v2alpha1.pipelines.html index 94895d92eec..02aa3c3d5a9 100644 --- a/docs/dyn/genomics_v2alpha1.pipelines.html +++ b/docs/dyn/genomics_v2alpha1.pipelines.html @@ -108,6 +108,10 @@

Method Details

"cipherText": "A String", # The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited. "keyName": "A String", # The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key. }, + "encryptedEnvironment": { # Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline. # The encrypted environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited. + "keyName": "A String", # The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key. + }, "entrypoint": "A String", # If specified, overrides the `ENTRYPOINT` specified in the container. "environment": { # The environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed. "a_key": "A String", @@ -134,6 +138,10 @@

Method Details

"timeout": "A String", # The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. }, ], + "encryptedEnvironment": { # Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline. # The encrypted environment to pass into every action. Each action can also specify its own encrypted environment. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited. + "keyName": "A String", # The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key. + }, "environment": { # The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value). "a_key": "A String", }, diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.global_.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.global_.features.html index 5bd8d3a1e16..59fe0eb5eb7 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.global_.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.global_.features.html @@ -116,7 +116,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. @@ -436,7 +436,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. @@ -696,7 +696,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. @@ -960,7 +960,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.global_.features.html b/docs/dyn/gkehub_v1beta.projects.locations.global_.features.html index 5c61beaaa98..41fbebfcdff 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.global_.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.global_.features.html @@ -116,7 +116,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. @@ -389,7 +389,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. @@ -602,7 +602,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. @@ -819,7 +819,7 @@

Method Details

"labels": { # GCP labels for this Feature. "a_key": "A String", }, - "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. + "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.html b/docs/dyn/gkehub_v1beta.projects.locations.html index 066f6a30414..fec51475049 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.html @@ -146,7 +146,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html index a0006174fbf..db65ff0241e 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

delete(parent, dicomWebPath, x__xgafv=None)

-

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a study while a delete operation is running for that study could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

+

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).

@@ -108,7 +108,7 @@

Method Details

delete(parent, dicomWebPath, x__xgafv=None) -
DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a study while a delete operation is running for that study could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
+  
DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
 
 Args:
   parent: string, A parameter (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html
index f0449d3e72a..6c45c2c6fa3 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.html
@@ -84,7 +84,7 @@ 

Instance Methods

Close httplib2 connections.

delete(parent, dicomWebPath, x__xgafv=None)

-

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a series while a delete operation is running for that series could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

+

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).

@@ -102,7 +102,7 @@

Method Details

delete(parent, dicomWebPath, x__xgafv=None) -
DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a series while a delete operation is running for that series could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
+  
DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
 
 Args:
   parent: string, The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
index 99171b8230f..e485f064df3 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
@@ -134,6 +134,7 @@ 

Method Details

The object takes the form of: { # Represents a FHIR store. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. @@ -153,7 +154,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -173,6 +174,7 @@

Method Details

An object of the form: { # Represents a FHIR store. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. @@ -192,7 +194,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -338,7 +340,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "gcsDestination": { # The configuration for exporting to Cloud Storage. # The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource. "uriPrefix": "A String", # URI for a Cloud Storage directory where result files should be written, in the format of `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. @@ -389,6 +391,7 @@

Method Details

An object of the form: { # Represents a FHIR store. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. @@ -408,7 +411,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -532,6 +535,7 @@

Method Details

{ # Lists the FHIR stores in the given dataset. "fhirStores": [ # The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. { # Represents a FHIR store. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. @@ -551,7 +555,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -589,6 +593,7 @@

Method Details

The object takes the form of: { # Represents a FHIR store. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. @@ -608,7 +613,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -628,6 +633,7 @@

Method Details

An object of the form: { # Represents a FHIR store. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. @@ -647,7 +653,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", diff --git a/docs/dyn/healthcare_v1.projects.locations.html b/docs/dyn/healthcare_v1.projects.locations.html index 5c9add9b3ce..1c6f8a4814a 100644 --- a/docs/dyn/healthcare_v1.projects.locations.html +++ b/docs/dyn/healthcare_v1.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html index aaa3d7bb3ac..8274e731251 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html @@ -189,7 +189,7 @@

Method Details

"force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaType": "A String", # Specifies the schema format to export. "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, must be of the form bq://projectId.bqDatasetId.tableId. - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "evalInfoTypeMapping": { # Optional. InfoType mapping for `eval_store`. Different resources can map to the same infoType. For example, `PERSON_NAME`, `PERSON`, `NAME`, and `HUMAN` are different. To map all of these into a single infoType (such as `PERSON_NAME`), specify the following mapping: ``` info_type_mapping["PERSON"] = "PERSON_NAME" info_type_mapping["NAME"] = "PERSON_NAME" info_type_mapping["HUMAN"] = "PERSON_NAME" ``` Unmentioned infoTypes, such as `DATE`, are treated as identity mapping. For example: ``` info_type_mapping["DATE"] = "DATE" ``` InfoTypes are case-insensitive. "a_key": "A String", @@ -256,7 +256,7 @@

Method Details

"force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaType": "A String", # Specifies the schema format to export. "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, must be of the form bq://projectId.bqDatasetId.tableId. - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "gcsDestination": { # The Cloud Storage location for export. # The Cloud Storage destination, which requires the `roles/storage.objectAdmin` Cloud IAM role. "uriPrefix": "A String", # The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html index 619b55dee2e..8e09b86f94d 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

delete(parent, dicomWebPath, x__xgafv=None)

-

DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: If you insert instances into a study while a delete operation is running for that study, the instances you insert might not appear in search results until after the deletion operation finishes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

+

DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).

@@ -108,7 +108,7 @@

Method Details

delete(parent, dicomWebPath, x__xgafv=None) -
DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: If you insert instances into a study while a delete operation is running for that study, the instances you insert might not appear in search results until after the deletion operation finishes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
+  
DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
 
 Args:
   parent: string, A parameter (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html
index f286b161336..5c3c7f165f4 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html
@@ -84,7 +84,7 @@ 

Instance Methods

Close httplib2 connections.

delete(parent, dicomWebPath, x__xgafv=None)

-

DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: If you insert instances into a series while a delete operation is running for that series, the instances you insert might not appear in search results until after the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

+

DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).

@@ -102,7 +102,7 @@

Method Details

delete(parent, dicomWebPath, x__xgafv=None) -
DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: If you insert instances into a series while a delete operation is running for that series, the instances you insert might not appear in search results until after the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
+  
DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
 
 Args:
   parent: string, The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
index 8cdb2db1d7a..e75dc631842 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
@@ -154,7 +154,7 @@ 

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -200,7 +200,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -358,7 +358,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "gcsDestination": { # The configuration for exporting to Cloud Storage. # The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource. "uriPrefix": "A String", # URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service appends one when composing the object path. The Cloud Storage bucket referenced in `uri_prefix` must exist or an error occurs. @@ -429,7 +429,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -579,7 +579,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -643,7 +643,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", @@ -689,7 +689,7 @@

Method Details

"recursiveStructureDepth": "A String", # The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. "schemaType": "A String", # Specifies the output schema type. Schema type is required. }, - "writeDisposition": "A String", # Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, "resourceTypes": [ # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.html b/docs/dyn/healthcare_v1beta1.projects.locations.html index fe63a463cec..a33ef5214a8 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 990335e19f7..ef7fa2f4f30 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -42,6 +42,7 @@ ## adsense * [v1.4](http://googleapis.github.io/google-api-python-client/docs/dyn/adsense_v1_4.html) +* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/adsense_v2.html) ## adsensehost @@ -93,6 +94,10 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/apigee_v1.html) +## apikeys +* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/apikeys_v2.html) + + ## appengine * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/appengine_v1.html) * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/appengine_v1alpha.html) @@ -407,6 +412,10 @@ * [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/driveactivity_v2.html) +## essentialcontacts +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/essentialcontacts_v1.html) + + ## eventarc * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/eventarc_v1.html) * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/eventarc_v1beta1.html) diff --git a/docs/dyn/jobs_v3.projects.jobs.html b/docs/dyn/jobs_v3.projects.jobs.html index 0c392090176..76116a1c096 100644 --- a/docs/dyn/jobs_v3.projects.jobs.html +++ b/docs/dyn/jobs_v3.projects.jobs.html @@ -152,7 +152,7 @@

Method Details

{ # Input only. Create job request. "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Required. The Job to be created. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -304,7 +304,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -480,7 +480,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -650,7 +650,7 @@

Method Details

{ # Output only. List jobs response. "jobs": [ # The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -824,7 +824,7 @@

Method Details

{ # Input only. Update job request. "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Required. The Job to be updated. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -977,7 +977,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -1369,7 +1369,7 @@

Method Details

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. }, "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Job resource that matches the specified SearchJobsRequest. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -1776,7 +1776,7 @@

Method Details

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. }, "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Job resource that matches the specified SearchJobsRequest. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. diff --git a/docs/dyn/jobs_v3p1beta1.projects.jobs.html b/docs/dyn/jobs_v3p1beta1.projects.jobs.html index 0512399eb20..7397f12c11c 100644 --- a/docs/dyn/jobs_v3p1beta1.projects.jobs.html +++ b/docs/dyn/jobs_v3p1beta1.projects.jobs.html @@ -152,7 +152,7 @@

Method Details

{ # Input only. Create job request. "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Required. The Job to be created. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -304,7 +304,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -480,7 +480,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -650,7 +650,7 @@

Method Details

{ # Output only. List jobs response. "jobs": [ # The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -824,7 +824,7 @@

Method Details

{ # Input only. Update job request. "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Required. The Job to be updated. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -977,7 +977,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -1167,7 +1167,7 @@

Method Details

}, "histogramQueries": [ # Optional. Expression based histogram requests for jobs matching JobQuery. { # Input Only. The histogram request. - "histogramQuery": "A String", # An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level. For example, "Entry Level". * country: histogram by the country code of jobs. For example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country". For example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute["some-string-custom-attribute"]) * count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"]) + "histogramQuery": "A String", # An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level. For example, "Entry Level". * country: histogram by the country code of jobs. For example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country". For example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute["some-string-custom-attribute"]) * count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")]) }, ], "jobQuery": { # Input only. The query required to perform a search query. # Optional. Query used to search against jobs, such as keyword, location filters, etc. @@ -1389,7 +1389,7 @@

Method Details

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. }, "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Job resource that matches the specified SearchJobsRequest. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. @@ -1594,7 +1594,7 @@

Method Details

}, "histogramQueries": [ # Optional. Expression based histogram requests for jobs matching JobQuery. { # Input Only. The histogram request. - "histogramQuery": "A String", # An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level. For example, "Entry Level". * country: histogram by the country code of jobs. For example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country". For example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute["some-string-custom-attribute"]) * count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"]) + "histogramQuery": "A String", # An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level. For example, "Entry Level". * country: histogram by the country code of jobs. For example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country". For example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute["some-string-custom-attribute"]) * count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")]) }, ], "jobQuery": { # Input only. The query required to perform a search query. # Optional. Query used to search against jobs, such as keyword, location filters, etc. @@ -1816,7 +1816,7 @@

Method Details

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. }, "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Job resource that matches the specified SearchJobsRequest. - "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Required. At least one field within ApplicationInfo must be specified. Job application information. diff --git a/docs/dyn/jobs_v4.projects.tenants.jobs.html b/docs/dyn/jobs_v4.projects.tenants.jobs.html index 37336bb26c0..cd2825be6ab 100644 --- a/docs/dyn/jobs_v4.projects.tenants.jobs.html +++ b/docs/dyn/jobs_v4.projects.tenants.jobs.html @@ -129,7 +129,7 @@

Method Details

{ # Request to create a batch of jobs. "jobs": [ # Required. The jobs to be created. A maximum of 200 jobs can be created in a batch. { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -359,7 +359,7 @@

Method Details

{ # Request to update a batch of jobs. "jobs": [ # Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch. { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -549,7 +549,7 @@

Method Details

The object takes the form of: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -701,7 +701,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -878,7 +878,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -1049,7 +1049,7 @@

Method Details

{ # List jobs response. "jobs": [ # The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -1223,7 +1223,7 @@

Method Details

The object takes the form of: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -1376,7 +1376,7 @@

Method Details

An object of the form: { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -1537,7 +1537,7 @@

Method Details

"disableKeywordMatch": True or False, # Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. "diversificationLevel": "A String", # Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. "enableBroadening": True or False, # Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. - "histogramQueries": [ # An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level, for example, "Entry Level". * country: histogram by the country code of jobs, for example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code, for example, "en", "fr". * category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute["some-string-custom-attribute"])` * `count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"])` + "histogramQueries": [ # An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level, for example, "Entry Level". * country: histogram by the country code of jobs, for example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code, for example, "en", "fr". * category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute["some-string-custom-attribute"])` * `count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])` { # The histogram request. "histogramQuery": "A String", # An expression specifies a histogram request against matching jobs for searches. See SearchJobsRequest.histogram_queries for details about syntax. }, @@ -1711,7 +1711,7 @@

Method Details

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job isn't reachable within the requested duration, but was returned as part of an expanded query. }, "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Job resource that matches the specified SearchJobsRequest. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. @@ -1888,7 +1888,7 @@

Method Details

"disableKeywordMatch": True or False, # Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. "diversificationLevel": "A String", # Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. "enableBroadening": True or False, # Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. - "histogramQueries": [ # An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level, for example, "Entry Level". * country: histogram by the country code of jobs, for example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code, for example, "en", "fr". * category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute["some-string-custom-attribute"])` * `count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"])` + "histogramQueries": [ # An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level, for example, "Entry Level". * country: histogram by the country code of jobs, for example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code, for example, "en", "fr". * category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute["some-string-custom-attribute"])` * `count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])` { # The histogram request. "histogramQuery": "A String", # An expression specifies a histogram request against matching jobs for searches. See SearchJobsRequest.histogram_queries for details about syntax. }, @@ -2062,7 +2062,7 @@

Method Details

"travelDuration": "A String", # The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job isn't reachable within the requested duration, but was returned as part of an expanded query. }, "job": { # A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. # Job resource that matches the specified SearchJobsRequest. - "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + "addresses": [ # Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. "A String", ], "applicationInfo": { # Application related details of a job posting. # Job application information. diff --git a/docs/dyn/logging_v2.billingAccounts.buckets.html b/docs/dyn/logging_v2.billingAccounts.buckets.html index e567d7e7a31..2a04fa476e4 100644 --- a/docs/dyn/logging_v2.billingAccounts.buckets.html +++ b/docs/dyn/logging_v2.billingAccounts.buckets.html @@ -111,6 +111,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
diff --git a/docs/dyn/logging_v2.billingAccounts.locations.buckets.html b/docs/dyn/logging_v2.billingAccounts.locations.buckets.html index 1586972d936..6beadf0f84f 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.buckets.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.buckets.html @@ -121,6 +121,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -140,6 +143,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -187,6 +193,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }, @@ -224,6 +233,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -243,6 +255,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
diff --git a/docs/dyn/logging_v2.billingAccounts.locations.html b/docs/dyn/logging_v2.billingAccounts.locations.html index 6bbdbf581ef..4e276e6848c 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/logging_v2.billingAccounts.logs.html b/docs/dyn/logging_v2.billingAccounts.logs.html index 7e1dea5c622..447deb5cfcc 100644 --- a/docs/dyn/logging_v2.billingAccounts.logs.html +++ b/docs/dyn/logging_v2.billingAccounts.logs.html @@ -97,7 +97,7 @@

Method Details

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.
 
 Args:
-  logName: string, Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. (required)
+  logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,10 +115,10 @@ 

Method Details

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
 
 Args:
-  parent: string, Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"  (required)
+  parent: string, Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (required)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
-  resourceNames: string, Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: "projects/PROJECT_ID" "organizations/ORGANIZATION_ID" "billingAccounts/BILLING_ACCOUNT_ID" "folders/FOLDER_ID" (repeated)
+  resourceNames: string, Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/logging_v2.entries.html b/docs/dyn/logging_v2.entries.html
index 2f24773c3e2..820e77f3284 100644
--- a/docs/dyn/logging_v2.entries.html
+++ b/docs/dyn/logging_v2.entries.html
@@ -111,7 +111,7 @@ 

Method Details

"projectIds": [ # Optional. Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A". "A String", ], - "resourceNames": [ # Required. Names of one or more parent resources from which to retrieve log entries: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" May alternatively be one or more views projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDProjects listed in the project_ids field are added to this list. + "resourceNames": [ # Required. Names of one or more parent resources from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]Projects listed in the project_ids field are added to this list. "A String", ], } @@ -218,7 +218,7 @@

Method Details

{ # The parameters to TailLogEntries. "bufferWindow": "A String", # Optional. The amount of time to buffer log entries at the server before being returned to prevent out of order results due to late arriving log entries. Valid values are between 0-60000 milliseconds. Defaults to 2000 milliseconds. "filter": "A String", # Optional. A filter that chooses which log entries to return. See Advanced Logs Filters (https://cloud.google.com/logging/docs/view/advanced_filters). Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters. - "resourceNames": [ # Required. Name of a parent resource from which to retrieve log entries: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" May alternatively be one or more views: "projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID" "organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID" "billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID" "folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID" + "resourceNames": [ # Required. Name of a parent resource from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] "A String", ], } @@ -382,7 +382,7 @@

Method Details

"labels": { # Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry. "a_key": "A String", }, - "logName": "A String", # Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example: "projects/my-project-id/logs/syslog" "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity" The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry. + "logName": "A String", # Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example: "projects/my-project-id/logs/syslog" "organizations/123/logs/cloudaudit.googleapis.com%2Factivity" The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry. "partialSuccess": True or False, # Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method. "resource": { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} # Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See LogEntry. "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone". diff --git a/docs/dyn/logging_v2.folders.locations.buckets.html b/docs/dyn/logging_v2.folders.locations.buckets.html index f9cfe577342..135108a9419 100644 --- a/docs/dyn/logging_v2.folders.locations.buckets.html +++ b/docs/dyn/logging_v2.folders.locations.buckets.html @@ -124,6 +124,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -143,6 +146,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -186,6 +192,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -215,6 +224,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }, @@ -252,6 +264,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -271,6 +286,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
diff --git a/docs/dyn/logging_v2.folders.locations.html b/docs/dyn/logging_v2.folders.locations.html index 7ff54b7a999..d94bd359d08 100644 --- a/docs/dyn/logging_v2.folders.locations.html +++ b/docs/dyn/logging_v2.folders.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/logging_v2.folders.logs.html b/docs/dyn/logging_v2.folders.logs.html index fc6357fa006..a390b12ed43 100644 --- a/docs/dyn/logging_v2.folders.logs.html +++ b/docs/dyn/logging_v2.folders.logs.html @@ -97,7 +97,7 @@

Method Details

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.
 
 Args:
-  logName: string, Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. (required)
+  logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,10 +115,10 @@ 

Method Details

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
 
 Args:
-  parent: string, Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"  (required)
+  parent: string, Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (required)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
-  resourceNames: string, Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: "projects/PROJECT_ID" "organizations/ORGANIZATION_ID" "billingAccounts/BILLING_ACCOUNT_ID" "folders/FOLDER_ID" (repeated)
+  resourceNames: string, Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/logging_v2.locations.buckets.html b/docs/dyn/logging_v2.locations.buckets.html
index 99d313475d9..1e501d3d128 100644
--- a/docs/dyn/logging_v2.locations.buckets.html
+++ b/docs/dyn/logging_v2.locations.buckets.html
@@ -124,6 +124,9 @@ 

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -143,6 +146,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -186,6 +192,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -215,6 +224,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }, @@ -252,6 +264,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -271,6 +286,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
diff --git a/docs/dyn/logging_v2.locations.html b/docs/dyn/logging_v2.locations.html index 302ee19f15a..fbc439eab72 100644 --- a/docs/dyn/logging_v2.locations.html +++ b/docs/dyn/logging_v2.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/logging_v2.logs.html b/docs/dyn/logging_v2.logs.html index 12b10dc8046..b68eb2e3e88 100644 --- a/docs/dyn/logging_v2.logs.html +++ b/docs/dyn/logging_v2.logs.html @@ -97,7 +97,7 @@

Method Details

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.
 
 Args:
-  logName: string, Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. (required)
+  logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,10 +115,10 @@ 

Method Details

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
 
 Args:
-  parent: string, Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"  (required)
+  parent: string, Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (required)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
-  resourceNames: string, Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: "projects/PROJECT_ID" "organizations/ORGANIZATION_ID" "billingAccounts/BILLING_ACCOUNT_ID" "folders/FOLDER_ID" (repeated)
+  resourceNames: string, Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/logging_v2.organizations.locations.buckets.html b/docs/dyn/logging_v2.organizations.locations.buckets.html
index a46e18c8969..5ec17bb5ed4 100644
--- a/docs/dyn/logging_v2.organizations.locations.buckets.html
+++ b/docs/dyn/logging_v2.organizations.locations.buckets.html
@@ -124,6 +124,9 @@ 

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -143,6 +146,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -186,6 +192,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -215,6 +224,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }, @@ -252,6 +264,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -271,6 +286,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
diff --git a/docs/dyn/logging_v2.organizations.locations.html b/docs/dyn/logging_v2.organizations.locations.html index 665b5725e56..ced3a5b26fa 100644 --- a/docs/dyn/logging_v2.organizations.locations.html +++ b/docs/dyn/logging_v2.organizations.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/logging_v2.organizations.logs.html b/docs/dyn/logging_v2.organizations.logs.html index a74cd73fb6c..878a3598633 100644 --- a/docs/dyn/logging_v2.organizations.logs.html +++ b/docs/dyn/logging_v2.organizations.logs.html @@ -97,7 +97,7 @@

Method Details

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.
 
 Args:
-  logName: string, Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. (required)
+  logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,10 +115,10 @@ 

Method Details

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
 
 Args:
-  parent: string, Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"  (required)
+  parent: string, Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (required)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
-  resourceNames: string, Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: "projects/PROJECT_ID" "organizations/ORGANIZATION_ID" "billingAccounts/BILLING_ACCOUNT_ID" "folders/FOLDER_ID" (repeated)
+  resourceNames: string, Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/logging_v2.projects.locations.buckets.html b/docs/dyn/logging_v2.projects.locations.buckets.html
index 88b47588cd7..1bc9c1054c1 100644
--- a/docs/dyn/logging_v2.projects.locations.buckets.html
+++ b/docs/dyn/logging_v2.projects.locations.buckets.html
@@ -124,6 +124,9 @@ 

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -143,6 +146,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -186,6 +192,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
@@ -215,6 +224,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }, @@ -252,6 +264,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. } @@ -271,6 +286,9 @@

Method Details

"lifecycleState": "A String", # Output only. The bucket lifecycle state. "locked": True or False, # Whether the bucket has been locked. The retention period on a locked bucket may not be changed. Locked buckets may only be deleted if they are empty. "name": "A String", # Output only. The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + "restrictedFields": [ # Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz. + "A String", + ], "retentionDays": 42, # Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. "updateTime": "A String", # Output only. The last update timestamp of the bucket. }
diff --git a/docs/dyn/logging_v2.projects.locations.html b/docs/dyn/logging_v2.projects.locations.html index b18b921d28d..ee7fbd93a52 100644 --- a/docs/dyn/logging_v2.projects.locations.html +++ b/docs/dyn/logging_v2.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/logging_v2.projects.logs.html b/docs/dyn/logging_v2.projects.logs.html index e67ddac21fe..da288b4fcb8 100644 --- a/docs/dyn/logging_v2.projects.logs.html +++ b/docs/dyn/logging_v2.projects.logs.html @@ -97,7 +97,7 @@

Method Details

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.
 
 Args:
-  logName: string, Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. (required)
+  logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,10 +115,10 @@ 

Method Details

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
 
 Args:
-  parent: string, Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"  (required)
+  parent: string, Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (required)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
-  resourceNames: string, Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: "projects/PROJECT_ID" "organizations/ORGANIZATION_ID" "billingAccounts/BILLING_ACCOUNT_ID" "folders/FOLDER_ID" (repeated)
+  resourceNames: string, Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/metastore_v1alpha.projects.locations.html b/docs/dyn/metastore_v1alpha.projects.locations.html
index 9108fe1beff..f988beed57f 100644
--- a/docs/dyn/metastore_v1alpha.projects.locations.html
+++ b/docs/dyn/metastore_v1alpha.projects.locations.html
@@ -136,7 +136,7 @@ 

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html index 3885f15bafe..eb687ae71e7 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

create(parent, backupId=None, body=None, requestId=None, x__xgafv=None)

-

Creates a new Backup in a given project and location.

+

Creates a new backup in a given project and location.

delete(name, requestId=None, x__xgafv=None)

Deletes a single backup.

@@ -100,7 +100,7 @@

Method Details

create(parent, backupId=None, body=None, requestId=None, x__xgafv=None) -
Creates a new Backup in a given project and location.
+  
Creates a new backup in a given project and location.
 
 Args:
   parent: string, Required. The relative resource name of the service in which to create a backup of the following form:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
diff --git a/docs/dyn/metastore_v1beta.projects.locations.html b/docs/dyn/metastore_v1beta.projects.locations.html
index 5d02d3e96d8..611d4c2c1b8 100644
--- a/docs/dyn/metastore_v1beta.projects.locations.html
+++ b/docs/dyn/metastore_v1beta.projects.locations.html
@@ -136,7 +136,7 @@ 

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html index 15a33c9b700..66ba7c92ff8 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

create(parent, backupId=None, body=None, requestId=None, x__xgafv=None)

-

Creates a new Backup in a given project and location.

+

Creates a new backup in a given project and location.

delete(name, requestId=None, x__xgafv=None)

Deletes a single backup.

@@ -100,7 +100,7 @@

Method Details

create(parent, backupId=None, body=None, requestId=None, x__xgafv=None) -
Creates a new Backup in a given project and location.
+  
Creates a new backup in a given project and location.
 
 Args:
   parent: string, Required. The relative resource name of the service in which to create a backup of the following form:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html
index 138213c1daf..83a8670417e 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html
@@ -151,7 +151,7 @@ 

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. @@ -168,6 +168,14 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "displayName": "A String", # Name of a Cloud SQL instance. + "externalIp": "A String", # External IP address of Cloud SQL instance. + "internalIp": "A String", # Internal IP address of Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "region": "A String", # Region in which the Cloud SQL instance is running. + "uri": "A String", # URI of a Cloud SQL instance. + }, "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. @@ -215,6 +223,12 @@

Method Details

"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. + "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. + "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. + "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -413,7 +427,7 @@

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. @@ -430,6 +444,14 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "displayName": "A String", # Name of a Cloud SQL instance. + "externalIp": "A String", # External IP address of Cloud SQL instance. + "internalIp": "A String", # Internal IP address of Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "region": "A String", # Region in which the Cloud SQL instance is running. + "uri": "A String", # URI of a Cloud SQL instance. + }, "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. @@ -477,6 +499,12 @@

Method Details

"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. + "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. + "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. + "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -666,7 +694,7 @@

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. @@ -683,6 +711,14 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "displayName": "A String", # Name of a Cloud SQL instance. + "externalIp": "A String", # External IP address of Cloud SQL instance. + "internalIp": "A String", # Internal IP address of Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "region": "A String", # Region in which the Cloud SQL instance is running. + "uri": "A String", # URI of a Cloud SQL instance. + }, "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. @@ -730,6 +766,12 @@

Method Details

"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. + "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. + "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. + "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -878,7 +920,7 @@

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. @@ -895,6 +937,14 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "displayName": "A String", # Name of a Cloud SQL instance. + "externalIp": "A String", # External IP address of Cloud SQL instance. + "internalIp": "A String", # Internal IP address of Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "region": "A String", # Region in which the Cloud SQL instance is running. + "uri": "A String", # URI of a Cloud SQL instance. + }, "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. @@ -942,6 +992,12 @@

Method Details

"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. + "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. + "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. + "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. diff --git a/docs/dyn/networkmanagement_v1.projects.locations.html b/docs/dyn/networkmanagement_v1.projects.locations.html index cd2a2d54072..df889df168f 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 725d7f95c3b..be3f628f16a 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -186,7 +186,7 @@

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. @@ -499,7 +499,7 @@

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. @@ -803,7 +803,7 @@

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. @@ -1066,7 +1066,7 @@

Method Details

}, "result": "A String", # The overall result of the test's configuration analysis. "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends. - { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` + { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.html index e29badd57c2..f9027d2c379 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.html @@ -131,7 +131,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/notebooks_v1.projects.locations.html b/docs/dyn/notebooks_v1.projects.locations.html index 484cdd5b032..54f26121b8b 100644 --- a/docs/dyn/notebooks_v1.projects.locations.html +++ b/docs/dyn/notebooks_v1.projects.locations.html @@ -156,7 +156,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html index 34aa0866760..69eff588759 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html @@ -102,7 +102,7 @@

Method Details

"os": "A String", # The OS affected by a vulnerability This field is deprecated and the information is in cpe_uri "osVersion": "A String", # The version of the OS This field is deprecated and the information is in cpe_uri "package": "A String", # The package being analysed for vulnerabilities - "projectId": "A String", # The projectId of the package to which this data belongs. Most of Drydock's code does not set or use this field. This is added specifically so we can group packages by projects and decide whether or not to apply NVD data to the packages belonging to a specific project. + "unused": "A String", "version": "A String", # The version of the package being analysed }, ], diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html index bd857e0044f..65f3d03c76b 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html @@ -102,7 +102,7 @@

Method Details

"os": "A String", # The OS affected by a vulnerability This field is deprecated and the information is in cpe_uri "osVersion": "A String", # The version of the OS This field is deprecated and the information is in cpe_uri "package": "A String", # The package being analysed for vulnerabilities - "projectId": "A String", # The projectId of the package to which this data belongs. Most of Drydock's code does not set or use this field. This is added specifically so we can group packages by projects and decide whether or not to apply NVD data to the packages belonging to a specific project. + "unused": "A String", "version": "A String", # The version of the package being analysed }, ], diff --git a/docs/dyn/oslogin_v1alpha.users.html b/docs/dyn/oslogin_v1alpha.users.html index 737e56d6e7d..14c8aaf5a27 100644 --- a/docs/dyn/oslogin_v1alpha.users.html +++ b/docs/dyn/oslogin_v1alpha.users.html @@ -114,7 +114,7 @@

Method Details

systemId: string, A system ID for filtering the results of the request. view: string, The view configures whether to retrieve security keys information. Allowed values - VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view. + LOGIN_PROFILE_VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view. BASIC - Includes POSIX and SSH key information. SECURITY_KEY - Include security key information for the user. x__xgafv: string, V1 error format. @@ -172,7 +172,7 @@

Method Details

projectId: string, The project ID of the Google Cloud Platform project. view: string, The view configures whether to retrieve security keys information. Allowed values - VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view. + LOGIN_PROFILE_VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view. BASIC - Includes POSIX and SSH key information. SECURITY_KEY - Include security key information for the user. x__xgafv: string, V1 error format. diff --git a/docs/dyn/people_v1.otherContacts.html b/docs/dyn/people_v1.otherContacts.html index 46305c54ffc..f6562ef76c5 100644 --- a/docs/dyn/people_v1.otherContacts.html +++ b/docs/dyn/people_v1.otherContacts.html @@ -1829,6 +1829,7 @@

Method Details

], }, ], + "totalSize": 42, # The total number of other contacts in the list without pagination. }
@@ -1851,7 +1852,7 @@

Method Details

Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT source.
 
 Args:
-  pageSize: integer, Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0.
+  pageSize: integer, Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 10 will be capped to 10.
   query: string, Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
   readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * names * phoneNumbers
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/people_v1.people.html b/docs/dyn/people_v1.people.html
index 5cf94de1682..65c67c9c0db 100644
--- a/docs/dyn/people_v1.people.html
+++ b/docs/dyn/people_v1.people.html
@@ -8858,7 +8858,7 @@ 

Method Details

Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT" source.
 
 Args:
-  pageSize: integer, Optional. The number of results to return.
+  pageSize: integer, Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 10 will be capped to 10.
   query: string, Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
   readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
   sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. (repeated)
diff --git a/docs/dyn/playablelocations_v3.v3.html b/docs/dyn/playablelocations_v3.v3.html
index 804ef18805c..abde129d283 100644
--- a/docs/dyn/playablelocations_v3.v3.html
+++ b/docs/dyn/playablelocations_v3.v3.html
@@ -220,14 +220,14 @@ 

Method Details

"a_key": { # A list of PlayableLocation objects that satisfies a single Criterion. "locations": [ # A list of playable locations for this game object type. { # A geographical point suitable for placing game objects in location-based games. - "centerPoint": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Required. The latitude and longitude associated with the center of the playable location. By default, the set of playable locations returned from SamplePlayableLocations use center-point coordinates. + "centerPoint": { # 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. # Required. The latitude and longitude associated with the center of the playable location. By default, the set of playable locations returned from SamplePlayableLocations use center-point coordinates. "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]. }, "name": "A String", # Required. The name of this playable location. "placeId": "A String", # A [place ID] (https://developers.google.com/places/place-id) "plusCode": "A String", # A [plus code] (http://openlocationcode.com) - "snappedPoint": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # The playable location's coordinates, snapped to the sidewalk of the nearest road, if a nearby road exists. + "snappedPoint": { # 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. # The playable location's coordinates, snapped to the sidewalk of the nearest road, if a nearby road exists. "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]. }, diff --git a/docs/dyn/realtimebidding_v1alpha.bidders.biddingFunctions.html b/docs/dyn/realtimebidding_v1alpha.bidders.biddingFunctions.html index b2639eb9547..f0a451cab0f 100644 --- a/docs/dyn/realtimebidding_v1alpha.bidders.biddingFunctions.html +++ b/docs/dyn/realtimebidding_v1alpha.bidders.biddingFunctions.html @@ -104,6 +104,7 @@

Method Details

{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. "biddingFunction": "A String", # The raw Javascript source code of the bidding function. "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. + "type": "A String", # The type of the bidding function to be created. } x__xgafv: string, V1 error format. @@ -117,6 +118,7 @@

Method Details

{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. "biddingFunction": "A String", # The raw Javascript source code of the bidding function. "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. + "type": "A String", # The type of the bidding function to be created. }
@@ -141,6 +143,7 @@

Method Details

{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow. "biddingFunction": "A String", # The raw Javascript source code of the bidding function. "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`. + "type": "A String", # The type of the bidding function to be created. }, ], "nextPageToken": "A String", # A token which can be passed to a subsequent call to the `ListBiddingFunctions` method to retrieve the next page of results in ListBiddingFunctionsRequest.pageToken. diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html index 9574127a66d..855fb5c0815 100644 --- a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html +++ b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html @@ -109,7 +109,7 @@

Method Details

Creates a catalog item.
 
 Args:
-  parent: string, Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog". (required)
+  parent: string, Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -243,7 +243,7 @@ 

Method Details

Deletes a catalog item.
 
 Args:
-  name: string, Required. Full resource name of catalog item, such as "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". (required)
+  name: string, Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -261,7 +261,7 @@ 

Method Details

Gets a specific catalog item.
 
 Args:
-  name: string, Required. Full resource name of catalog item, such as "projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id". (required)
+  name: string, Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -334,7 +334,7 @@ 

Method Details

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.
 
 Args:
-  parent: string, Required. "projects/1234/locations/global/catalogs/default_catalog" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission. (required)
+  parent: string, Required. `projects/1234/locations/global/catalogs/default_catalog` If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -412,7 +412,7 @@ 

Method Details

], }, "gcsSource": { # Google Cloud Storage location for input content. format. # Google Cloud Storage location for the input content. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], "jsonSchema": "A String", # Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user events imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) 2. "user_events_ga360" using https://support.google.com/analytics/answer/3437719?hl=en @@ -547,7 +547,7 @@

Method Details

Gets a list of catalog items.
 
 Args:
-  parent: string, Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog". (required)
+  parent: string, Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
   filter: string, Optional. A filter to apply on the list results.
   pageSize: integer, Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.
   pageToken: string, Optional. The previous ListCatalogItemsResponse.next_page_token.
@@ -642,7 +642,7 @@ 

Method Details

Updates a catalog item. Partial updating is supported. Non-existing items will be created.
 
 Args:
-  name: string, Required. Full resource name of catalog item, such as "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". (required)
+  name: string, Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html
index b3fe46193b6..a24feb66f40 100644
--- a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html
+++ b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.placements.html
@@ -94,7 +94,7 @@ 

Method Details

Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).
 
 Args:
-  name: string, Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard (required)
+  name: string, Required. Full resource name of the format: `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}` The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html
index 98125646595..4acce4ce88d 100644
--- a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html
+++ b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html
@@ -100,7 +100,7 @@ 

Method Details

Register an API key for use with predict method.
 
 Args:
-  parent: string, Required. The parent resource path. "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store". (required)
+  parent: string, Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -128,7 +128,7 @@ 

Method Details

Unregister an apiKey from using for predict method.
 
 Args:
-  name: string, Required. The API key to unregister including full resource path. "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/" (required)
+  name: string, Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -146,7 +146,7 @@ 

Method Details

List the registered apiKeys for use with predict method.
 
 Args:
-  parent: string, Required. The parent placement resource name such as "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store" (required)
+  parent: string, Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store` (required)
   pageSize: integer, Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.
   pageToken: string, Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.userEvents.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.userEvents.html
index f337ecad1b3..19ef5fcec49 100644
--- a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.userEvents.html
+++ b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.userEvents.html
@@ -109,7 +109,7 @@ 

Method Details

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.
 
 Args:
-  parent: string, Required. The parent eventStore name, such as "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store". (required)
+  parent: string, Required. The parent eventStore name, such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`. (required)
   ets: string, Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
   uri: string, Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more useful than the referer url, because many browsers only send the domain for 3rd party requests.
   userEvent: string, Required. URL encoded UserEvent proto.
@@ -137,7 +137,7 @@ 

Method Details

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
 
 Args:
-  parent: string, Required. "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store" (required)
+  parent: string, Required. `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -215,7 +215,7 @@ 

Method Details

], }, "gcsSource": { # Google Cloud Storage location for input content. format. # Google Cloud Storage location for the input content. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], "jsonSchema": "A String", # Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user events imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) 2. "user_events_ga360" using https://support.google.com/analytics/answer/3437719?hl=en @@ -349,7 +349,7 @@

Method Details

Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.
 
 Args:
-  parent: string, Required. The parent eventStore resource name, such as "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store". (required)
+  parent: string, Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`. (required)
   filter: string, Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems
   pageSize: integer, Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.
   pageToken: string, Optional. The previous ListUserEventsResponse.next_page_token.
@@ -474,7 +474,7 @@ 

Method Details

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
 
 Args:
-  parent: string, Required. The resource name of the event_store under which the events are created. The format is "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}" (required)
+  parent: string, Required. The resource name of the event_store under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -517,7 +517,7 @@ 

Method Details

Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.
 
 Args:
-  parent: string, Required. Full resource name of user event, such as "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store". (required)
+  parent: string, Required. Full resource name of user event, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.insights.html b/docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.insights.html
index d8e03962089..9eb0b4c2e3c 100644
--- a/docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.insights.html
+++ b/docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.insights.html
@@ -142,7 +142,7 @@ 

Method Details

Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
 
 Args:
-  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.) (required)
+  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. (required)
   filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
   pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
diff --git a/docs/dyn/recommender_v1.folders.locations.insightTypes.insights.html b/docs/dyn/recommender_v1.folders.locations.insightTypes.insights.html
index 60c1f86939c..fb59a2fe350 100644
--- a/docs/dyn/recommender_v1.folders.locations.insightTypes.insights.html
+++ b/docs/dyn/recommender_v1.folders.locations.insightTypes.insights.html
@@ -142,7 +142,7 @@ 

Method Details

Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
 
 Args:
-  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.) (required)
+  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. (required)
   filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
   pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
diff --git a/docs/dyn/recommender_v1.organizations.locations.insightTypes.insights.html b/docs/dyn/recommender_v1.organizations.locations.insightTypes.insights.html
index 53c102cc84f..1ba0f567904 100644
--- a/docs/dyn/recommender_v1.organizations.locations.insightTypes.insights.html
+++ b/docs/dyn/recommender_v1.organizations.locations.insightTypes.insights.html
@@ -142,7 +142,7 @@ 

Method Details

Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
 
 Args:
-  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.) (required)
+  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. (required)
   filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
   pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
diff --git a/docs/dyn/recommender_v1.projects.locations.insightTypes.insights.html b/docs/dyn/recommender_v1.projects.locations.insightTypes.insights.html
index e33abd12df9..4a3b1b7b497 100644
--- a/docs/dyn/recommender_v1.projects.locations.insightTypes.insights.html
+++ b/docs/dyn/recommender_v1.projects.locations.insightTypes.insights.html
@@ -142,7 +142,7 @@ 

Method Details

Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
 
 Args:
-  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.) (required)
+  parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. (required)
   filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
   pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
diff --git a/docs/dyn/redis_v1.projects.locations.html b/docs/dyn/redis_v1.projects.locations.html
index 78a365aa164..5287c0af80a 100644
--- a/docs/dyn/redis_v1.projects.locations.html
+++ b/docs/dyn/redis_v1.projects.locations.html
@@ -136,7 +136,7 @@ 

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/redis_v1beta1.projects.locations.html b/docs/dyn/redis_v1beta1.projects.locations.html index 830c1675703..36109f98044 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.html +++ b/docs/dyn/redis_v1beta1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html index 5783c015337..5ba70c3150f 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html @@ -294,12 +294,12 @@

Method Details

"dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. - "projectId": "A String", # The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request. + "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Google Cloud Storage location for input content. format. # Google Cloud Storage location for the input content. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], }, diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html index c8946af2a82..c20023eb0bd 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html @@ -97,7 +97,7 @@

Method Details

{ # Request message for Predict method. "filter": "A String", # Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000 characters. Note: "Recently viewed" models don't support tag filtering at the moment. * filterOutOfStockItems. Restricts predictions to products that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular products to be returned instead, set `strictFiltering` to false in `PredictRequest.params`. - "labels": { # The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels. + "labels": { # The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters, and cannot be empty. Values can be empty, and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, "pageSize": 42, # Maximum number of results to return per page. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. @@ -189,7 +189,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, "validateOnly": True or False, # Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready. } diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html index 75feff00dfc..81d166c7f9f 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html @@ -144,12 +144,12 @@

Method Details

"dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. - "projectId": "A String", # The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request. + "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Google Cloud Storage location for input content. format. # Required. Google Cloud Storage location for the input content. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], }, @@ -239,7 +239,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, ], }, @@ -453,7 +453,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } x__xgafv: string, V1 error format. @@ -548,7 +548,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html index 9d78cace0ef..82cb7dfd9c0 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html @@ -294,12 +294,12 @@

Method Details

"dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. - "projectId": "A String", # The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request. + "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Google Cloud Storage location for input content. format. # Google Cloud Storage location for the input content. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], }, diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html index e3872fce6c6..85316ed86e1 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html @@ -97,7 +97,7 @@

Method Details

{ # Request message for Predict method. "filter": "A String", # Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000 characters. Note: "Recently viewed" models don't support tag filtering at the moment. * filterOutOfStockItems. Restricts predictions to products that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular products to be returned instead, set `strictFiltering` to false in `PredictRequest.params`. - "labels": { # The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels. + "labels": { # The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters, and cannot be empty. Values can be empty, and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, "pageSize": 42, # Maximum number of results to return per page. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. @@ -189,7 +189,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, "validateOnly": True or False, # Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready. } diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html index 3c6601bd9df..b4b4da87868 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html @@ -144,12 +144,12 @@

Method Details

"dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. - "projectId": "A String", # The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request. + "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Google Cloud Storage location for input content. format. # Required. Google Cloud Storage location for the input content. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], }, @@ -239,7 +239,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, ], }, @@ -453,7 +453,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } x__xgafv: string, V1 error format. @@ -548,7 +548,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html index 87a95515abb..f8390176d50 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html @@ -294,12 +294,12 @@

Method Details

"dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. - "projectId": "A String", # The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request. + "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Google Cloud Storage location for input content. format. # Google Cloud Storage location for the input content. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], }, diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html index 066cc0f5d09..1e19977d525 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html @@ -97,7 +97,7 @@

Method Details

{ # Request message for Predict method. "filter": "A String", # Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000 characters. Note: "Recently viewed" models don't support tag filtering at the moment. * filterOutOfStockItems. Restricts predictions to products that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular products to be returned instead, set `strictFiltering` to false in `PredictRequest.params`. - "labels": { # The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels. + "labels": { # The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters, and cannot be empty. Values can be empty, and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, "pageSize": 42, # Maximum number of results to return per page. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. @@ -189,7 +189,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, "validateOnly": True or False, # Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready. } diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html index 322521f88d6..c14b6869308 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html @@ -144,12 +144,12 @@

Method Details

"dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. - "projectId": "A String", # The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request. + "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Google Cloud Storage location for input content. format. # Required. Google Cloud Storage location for the input content. - "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. - "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. + "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en. + "inputUris": [ # Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions. "A String", ], }, @@ -239,7 +239,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, ], }, @@ -453,7 +453,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } x__xgafv: string, V1 error format. @@ -548,7 +548,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, - "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }
diff --git a/docs/dyn/run_v1.projects.locations.html b/docs/dyn/run_v1.projects.locations.html index 2d1ecded3ca..cf37573ef8e 100644 --- a/docs/dyn/run_v1.projects.locations.html +++ b/docs/dyn/run_v1.projects.locations.html @@ -126,7 +126,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/secretmanager_v1.projects.secrets.versions.html b/docs/dyn/secretmanager_v1.projects.secrets.versions.html index 5c723d49ab2..a0d214324b6 100644 --- a/docs/dyn/secretmanager_v1.projects.secrets.versions.html +++ b/docs/dyn/secretmanager_v1.projects.secrets.versions.html @@ -76,7 +76,7 @@

Secret Manager API . access(name, x__xgafv=None)

-

Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.

+

Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

close()

Close httplib2 connections.

@@ -91,7 +91,7 @@

Instance Methods

Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.

get(name, x__xgafv=None)

-

Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.

+

Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

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

Lists SecretVersions. This call does not return secret data.

@@ -101,10 +101,10 @@

Instance Methods

Method Details

access(name, x__xgafv=None) -
Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.
+  
Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.
 
 Args:
-  name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. (required)
+  name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -263,10 +263,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.
+  
Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.
 
 Args:
-  name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion. (required)
+  name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html
index c307240e7e3..8219f1346d9 100644
--- a/docs/dyn/securitycenter_v1.folders.sources.findings.html
+++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html
@@ -205,7 +205,7 @@ 

Method Details

}, "state": "A String", # The state of the finding. }, - "resource": { # Information related to the Google Cloud resource that is associated with this finding. LINT.IfChange # Output only. Resource that is associated with this finding. + "resource": { # Information related to the Google Cloud resource that is associated with this finding. # Output only. Resource that is associated with this finding. "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. { # Message that contains the resource name and display name of a folder resource. "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index fcc11c44c2d..a2a841b37dc 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -273,7 +273,7 @@

Method Details

}, "state": "A String", # The state of the finding. }, - "resource": { # Information related to the Google Cloud resource that is associated with this finding. LINT.IfChange # Output only. Resource that is associated with this finding. + "resource": { # Information related to the Google Cloud resource that is associated with this finding. # Output only. Resource that is associated with this finding. "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. { # Message that contains the resource name and display name of a folder resource. "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index f5162232460..0cf84953a7d 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -205,7 +205,7 @@

Method Details

}, "state": "A String", # The state of the finding. }, - "resource": { # Information related to the Google Cloud resource that is associated with this finding. LINT.IfChange # Output only. Resource that is associated with this finding. + "resource": { # Information related to the Google Cloud resource that is associated with this finding. # Output only. Resource that is associated with this finding. "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. { # Message that contains the resource name and display name of a folder resource. "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index 1a4ae4a1b23..7c9ef29de05 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -150,7 +150,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -616,7 +616,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -1094,7 +1094,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -1572,7 +1572,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index f0149978ff5..cdc71fdcbc5 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -345,7 +345,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 4fd9e46aec3..57a5c9e03f6 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -204,7 +204,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. Contains only the OAuth rules. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. Contains only the OAuth rules. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -261,6 +261,9 @@

Method Details

}, "endpoints": [ # Configuration for network endpoints. Contains only the names and aliases of the endpoints. { # `Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true + "aliases": [ # Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. + "A String", + ], "allowCors": True or False, # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. "name": "A String", # The canonical name of this endpoint. "target": "A String", # The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". @@ -497,7 +500,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. Contains only the OAuth rules. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. Contains only the OAuth rules. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -554,6 +557,9 @@

Method Details

}, "endpoints": [ # Configuration for network endpoints. Contains only the names and aliases of the endpoints. { # `Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true + "aliases": [ # Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. + "A String", + ], "allowCors": True or False, # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. "name": "A String", # The canonical name of this endpoint. "target": "A String", # The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". @@ -705,7 +711,7 @@

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. Contains only the OAuth rules. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. Contains only the OAuth rules. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -762,6 +768,9 @@

Method Details

}, "endpoints": [ # Configuration for network endpoints. Contains only the names and aliases of the endpoints. { # `Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true + "aliases": [ # Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. + "A String", + ], "allowCors": True or False, # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. "name": "A String", # The canonical name of this endpoint. "target": "A String", # The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html index 9aeb0f46c36..cbb7d4720eb 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html @@ -87,10 +87,10 @@

Instance Methods

Retrieves a summary of quota information for a specific quota metric

importAdminOverrides(parent, body=None, x__xgafv=None)

-

Create or update multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

+

Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

importConsumerOverrides(parent, body=None, x__xgafv=None)

-

Create or update multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

+

Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

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

Retrieves a summary of all quota information visible to the service consumer, organized by service metric. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.

@@ -108,7 +108,7 @@

Method Details

Retrieves a summary of quota information for a specific quota metric
 
 Args:
-  name: string, The resource name of the quota limit. An example name would be: projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests (required)
+  name: string, The resource name of the quota limit. An example name would be: `projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests` (required)
   view: string, Specifies the level of detail for quota information in the response.
     Allowed values
       QUOTA_VIEW_UNSPECIFIED - No quota view specified. Requests that do not specify a quota view will typically default to the BASIC view.
@@ -132,8 +132,8 @@ 

Method Details

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first). { # A quota bucket is a quota provisioning unit for a specific set of dimensions. "adminOverride": { # A quota override # Admin override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -142,8 +142,8 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "consumerOverride": { # A quota override # Consumer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -152,13 +152,13 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration. - "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. + "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. "a_key": "A String", }, "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides. "producerOverride": { # A quota override # Producer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -180,8 +180,8 @@

Method Details

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first). { # A quota bucket is a quota provisioning unit for a specific set of dimensions. "adminOverride": { # A quota override # Admin override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -190,8 +190,8 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "consumerOverride": { # A quota override # Consumer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -200,13 +200,13 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration. - "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. + "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. "a_key": "A String", }, "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides. "producerOverride": { # A quota override # Producer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -219,16 +219,16 @@

Method Details

"unit": "A String", # The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, ], - "displayName": "A String", # The display name of the metric. An example name would be: "CPUs" + "displayName": "A String", # The display name of the metric. An example name would be: `CPUs` "metric": "A String", # The name of the metric. An example name would be: `compute.googleapis.com/cpus` - "name": "A String", # The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. + "name": "A String", # The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. "unit": "A String", # The units in which the metric value is reported. }
importAdminOverrides(parent, body=None, x__xgafv=None) -
Create or update multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
+  
Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
 
 Args:
   parent: string, The resource name of the consumer. An example name would be: `projects/123/services/compute.googleapis.com` (required)
@@ -243,8 +243,8 @@ 

Method Details

"inlineSource": { # Import data embedded in the request message # The import data is specified in the request message itself "overrides": [ # The overrides to create. Each override must have a value for 'metric' and 'unit', to specify which metric and which limit the override should be applied to. The 'name' field of the override does not need to be set; it is ignored. { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -287,7 +287,7 @@

Method Details

importConsumerOverrides(parent, body=None, x__xgafv=None) -
Create or update multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
+  
Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
 
 Args:
   parent: string, The resource name of the consumer. An example name would be: `projects/123/services/compute.googleapis.com` (required)
@@ -302,8 +302,8 @@ 

Method Details

"inlineSource": { # Import data embedded in the request message # The import data is specified in the request message itself "overrides": [ # The overrides to create. Each override must have a value for 'metric' and 'unit', to specify which metric and which limit the override should be applied to. The 'name' field of the override does not need to be set; it is ignored. { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -349,7 +349,7 @@

Method Details

Retrieves a summary of all quota information visible to the service consumer, organized by service metric. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.
 
 Args:
-  parent: string, Parent of the quotas resource. Some example names would be: projects/123/services/serviceconsumermanagement.googleapis.com folders/345/services/serviceconsumermanagement.googleapis.com organizations/456/services/serviceconsumermanagement.googleapis.com (required)
+  parent: string, Parent of the quotas resource. Some example names would be: `projects/123/services/serviceconsumermanagement.googleapis.com` `folders/345/services/serviceconsumermanagement.googleapis.com` `organizations/456/services/serviceconsumermanagement.googleapis.com` (required)
   pageSize: integer, Requested size of the next page of data.
   pageToken: string, Token identifying which result to start with; returned by a previous list call.
   view: string, Specifies the level of detail for quota information in the response.
@@ -377,8 +377,8 @@ 

Method Details

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first). { # A quota bucket is a quota provisioning unit for a specific set of dimensions. "adminOverride": { # A quota override # Admin override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -387,8 +387,8 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "consumerOverride": { # A quota override # Consumer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -397,13 +397,13 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration. - "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. + "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. "a_key": "A String", }, "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides. "producerOverride": { # A quota override # Producer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -425,8 +425,8 @@

Method Details

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first). { # A quota bucket is a quota provisioning unit for a specific set of dimensions. "adminOverride": { # A quota override # Admin override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -435,8 +435,8 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "consumerOverride": { # A quota override # Consumer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -445,13 +445,13 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration. - "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. + "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. "a_key": "A String", }, "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides. "producerOverride": { # A quota override # Producer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -464,9 +464,9 @@

Method Details

"unit": "A String", # The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, ], - "displayName": "A String", # The display name of the metric. An example name would be: "CPUs" + "displayName": "A String", # The display name of the metric. An example name would be: `CPUs` "metric": "A String", # The name of the metric. An example name would be: `compute.googleapis.com/cpus` - "name": "A String", # The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. + "name": "A String", # The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. "unit": "A String", # The units in which the metric value is reported. }, ], diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html index 5cce30f92bb..f9d71425687 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html @@ -108,8 +108,8 @@

Method Details

The object takes the form of: { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -214,8 +214,8 @@

Method Details

"nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list call. "overrides": [ # Admin overrides on this limit. { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -251,8 +251,8 @@

Method Details

The object takes the form of: { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.html index 543b3f301c5..e767a34b4ae 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.html @@ -108,8 +108,8 @@

Method Details

The object takes the form of: { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -214,8 +214,8 @@

Method Details

"nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list call. "overrides": [ # Consumer overrides on this limit. { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -251,8 +251,8 @@

Method Details

The object takes the form of: { # A quota override - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html index 655ed135f13..e575daf91a1 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html @@ -123,8 +123,8 @@

Method Details

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first). { # A quota bucket is a quota provisioning unit for a specific set of dimensions. "adminOverride": { # A quota override # Admin override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -133,8 +133,8 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "consumerOverride": { # A quota override # Consumer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` @@ -143,13 +143,13 @@

Method Details

"unit": "A String", # The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service configuration. - "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key "region" and value "us-east-1", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. + "dimensions": { # The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region. "a_key": "A String", }, "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there are no overrides. "producerOverride": { # A quota override # Producer override on this quota bucket. - "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. + "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. + "dimensions": { # If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map. "a_key": "A String", }, "metric": "A String", # The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index 023e1b87b0c..284068f3af6 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -81,32 +81,32 @@

Instance Methods

batchEnable(parent, body=None, x__xgafv=None)

-

Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation

+

Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation response type: `google.protobuf.Empty`

close()

Close httplib2 connections.

disable(name, body=None, x__xgafv=None)

-

Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation

+

Disables a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation response type: `google.protobuf.Empty`

enable(name, body=None, x__xgafv=None)

-

Enable a service so that it can be used with a project. Operation

+

Enables a service so that it can be used with a project. Operation response type: `google.protobuf.Empty`

generateServiceIdentity(parent, x__xgafv=None)

-

Generate service identity for service.

+

Generates service identity for service.

get(name, x__xgafv=None)

Returns the service configuration and enabled state for a given service.

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

-

List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.

+

Lists all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

batchEnable(parent, body=None, x__xgafv=None) -
Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation
+  
Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation response type: `google.protobuf.Empty`
 
 Args:
   parent: string, Parent to enable services on. An example name would be: `projects/123` where `123` is the project number (not project ID). The `BatchEnableServices` method currently only supports projects. (required)
@@ -155,7 +155,7 @@ 

Method Details

disable(name, body=None, x__xgafv=None) -
Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation
+  
Disables a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation response type: `google.protobuf.Empty`
 
 Args:
   name: string, Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). (required)
@@ -196,7 +196,7 @@ 

Method Details

enable(name, body=None, x__xgafv=None) -
Enable a service so that it can be used with a project. Operation
+  
Enables a service so that it can be used with a project. Operation response type: `google.protobuf.Empty`
 
 Args:
   name: string, Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). (required)
@@ -237,7 +237,7 @@ 

Method Details

generateServiceIdentity(parent, x__xgafv=None) -
Generate service identity for service.
+  
Generates service identity for service.
 
 Args:
   parent: string, Name of the consumer and service to generate an identity for. The `GenerateServiceIdentity` methods currently only support projects. An example name would be: `projects/123/services/example.googleapis.com` where `123` is the project number. (required)
@@ -328,7 +328,7 @@ 

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. Contains only the OAuth rules. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. Contains only the OAuth rules. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -385,6 +385,9 @@

Method Details

}, "endpoints": [ # Configuration for network endpoints. Contains only the names and aliases of the endpoints. { # `Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true + "aliases": [ # Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. + "A String", + ], "allowCors": True or False, # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. "name": "A String", # The canonical name of this endpoint. "target": "A String", # The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". @@ -466,15 +469,15 @@

Method Details

], }, }, - "name": "A String", # The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com - "parent": "A String", # The resource name of the consumer. A valid name would be: - projects/123 + "name": "A String", # The resource name of the consumer and service. A valid name would be: - `projects/123/services/serviceusage.googleapis.com` + "parent": "A String", # The resource name of the consumer. A valid name would be: - `projects/123` "state": "A String", # Whether or not the service has been enabled for use by the consumer. }
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.
+  
Lists all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.
 
 Args:
   parent: string, Parent to search for services on. An example name would be: `projects/123` where `123` is the project number (not project ID). (required)
@@ -536,7 +539,7 @@ 

Method Details

"version": "A String", # A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. }, ], - "authentication": { # `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth # Auth configuration. Contains only the OAuth rules. + "authentication": { # `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read # Auth configuration. Contains only the OAuth rules. "providers": [ # Defines a set of authentication providers that a service supports. { # Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). "audiences": "A String", # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com @@ -593,6 +596,9 @@

Method Details

}, "endpoints": [ # Configuration for network endpoints. Contains only the names and aliases of the endpoints. { # `Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true + "aliases": [ # Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. + "A String", + ], "allowCors": True or False, # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. "name": "A String", # The canonical name of this endpoint. "target": "A String", # The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". @@ -674,8 +680,8 @@

Method Details

], }, }, - "name": "A String", # The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com - "parent": "A String", # The resource name of the consumer. A valid name would be: - projects/123 + "name": "A String", # The resource name of the consumer and service. A valid name would be: - `projects/123/services/serviceusage.googleapis.com` + "parent": "A String", # The resource name of the consumer. A valid name would be: - `projects/123` "state": "A String", # Whether or not the service has been enabled for use by the consumer. }, ], diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html index 2fe4fd5ea35..5a34d9deee6 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html @@ -195,8 +195,8 @@

Method Details

}, "requestOptions": { # Common request options for various APIs. # Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. "priority": "A String", # Priority for the request. - "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}` + "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. }, } @@ -306,8 +306,8 @@

Method Details

], "requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. - "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}` + "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. }, "returnCommitStats": True or False, # If `true`, then statistics related to the transaction will be included in the CommitResponse. Default value is `false`. "singleUseTransaction": { # # Transactions Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. # Transaction Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. This transaction type provides guaranteed consistency across several reads, but does not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past. Snapshot read-only transactions do not need to be committed. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read/write data in a single database. They may, however, read/write data in different tables within that database. ## Locking Read-Write Transactions Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. ## Semantics Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. ## Retrying Aborted Transactions When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (e.g., many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of wall time spent retrying. ## Idle Transactions A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. In that case, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transaction, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. ## Strong Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. See TransactionOptions.ReadOnly.strong. ## Exact Staleness These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp <= the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ## Bounded Staleness Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. ## Old Read Timestamps and Garbage Collection Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## Partitioned DML Transactions Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table. # Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. @@ -411,8 +411,8 @@

Method Details

{ # The request for ExecuteBatchDml. "requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. - "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}` + "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. }, "seqno": "A String", # Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. "statements": [ # Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. @@ -421,7 +421,14 @@

Method Details

"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. + { # Message representing a single field of a struct. + "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. + "type": # Object with schema name: Type # The type of the field. + }, + ], + }, }, }, "params": { # Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. @@ -479,11 +486,7 @@

Method Details

"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. { # Message representing a single field of a struct. "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field. - "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. - "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. - }, + "type": # Object with schema name: Type # The type of the field. }, ], }, @@ -560,7 +563,14 @@

Method Details

"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. + { # Message representing a single field of a struct. + "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. + "type": # Object with schema name: Type # The type of the field. + }, + ], + }, }, }, "params": { # Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. @@ -574,8 +584,8 @@

Method Details

}, "requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. - "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}` + "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. }, "resumeToken": "A String", # If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. "seqno": "A String", # A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. @@ -627,11 +637,7 @@

Method Details

"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. { # Message representing a single field of a struct. "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field. - "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. - "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. - }, + "type": # Object with schema name: Type # The type of the field. }, ], }, @@ -697,7 +703,14 @@

Method Details

"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. + { # Message representing a single field of a struct. + "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. + "type": # Object with schema name: Type # The type of the field. + }, + ], + }, }, }, "params": { # Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. @@ -711,8 +724,8 @@

Method Details

}, "requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. - "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}` + "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. }, "resumeToken": "A String", # If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. "seqno": "A String", # A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. @@ -765,11 +778,7 @@

Method Details

"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. { # Message representing a single field of a struct. "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field. - "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. - "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. - }, + "type": # Object with schema name: Type # The type of the field. }, ], }, @@ -904,7 +913,14 @@

Method Details

"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields. + "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. + { # Message representing a single field of a struct. + "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. + "type": # Object with schema name: Type # The type of the field. + }, + ], + }, }, }, "params": { # Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. @@ -1108,8 +1124,8 @@

Method Details

"partitionToken": "A String", # If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. "requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. - "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}` + "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. }, "resumeToken": "A String", # If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. "table": "A String", # Required. The name of the table in the database to be read. @@ -1160,11 +1176,7 @@

Method Details

"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. { # Message representing a single field of a struct. "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field. - "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. - "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. - }, + "type": # Object with schema name: Type # The type of the field. }, ], }, @@ -1283,8 +1295,8 @@

Method Details

"partitionToken": "A String", # If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. "requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. - "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}` + "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn’t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. }, "resumeToken": "A String", # If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. "table": "A String", # Required. The name of the table in the database to be read. @@ -1336,11 +1348,7 @@

Method Details

"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. { # Message representing a single field of a struct. "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field. - "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements. - "code": "A String", # Required. The TypeCode for this type. - "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields. - }, + "type": # Object with schema name: Type # The type of the field. }, ], }, diff --git a/docs/dyn/speech_v1.speech.html b/docs/dyn/speech_v1.speech.html index c09c4358dcd..ebdb4704b69 100644 --- a/docs/dyn/speech_v1.speech.html +++ b/docs/dyn/speech_v1.speech.html @@ -126,7 +126,7 @@

Method Details

"recordingDeviceName": "A String", # The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. "recordingDeviceType": "A String", # The type of device the speech was recorded with. }, - "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. + "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. "profanityFilter": True or False, # If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. "sampleRateHertz": 42, # Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. "speechContexts": [ # Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation). @@ -206,7 +206,7 @@

Method Details

"recordingDeviceName": "A String", # The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. "recordingDeviceType": "A String", # The type of device the speech was recorded with. }, - "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. + "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. "profanityFilter": True or False, # If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. "sampleRateHertz": 42, # Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. "speechContexts": [ # Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation). diff --git a/docs/dyn/speech_v1p1beta1.speech.html b/docs/dyn/speech_v1p1beta1.speech.html index f7382460f95..0b1fda9154a 100644 --- a/docs/dyn/speech_v1p1beta1.speech.html +++ b/docs/dyn/speech_v1p1beta1.speech.html @@ -163,7 +163,7 @@

Method Details

"recordingDeviceName": "A String", # The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. "recordingDeviceType": "A String", # The type of device the speech was recorded with. }, - "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. + "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. "profanityFilter": True or False, # If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. "sampleRateHertz": 42, # Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. "speechContexts": [ # Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation). @@ -284,7 +284,7 @@

Method Details

"recordingDeviceName": "A String", # The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. "recordingDeviceType": "A String", # The type of device the speech was recorded with. }, - "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. + "model": "A String", # Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. "profanityFilter": True or False, # If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. "sampleRateHertz": 42, # Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. "speechContexts": [ # Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation). diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 76afdc3db1c..6f2bbf8151d 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -798,6 +798,10 @@

Method Details

"password": "A String", # The password for connecting to on-premises instance. "username": "A String", # The username for connecting to on-premises instance. }, + "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend + "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. "region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. @@ -1095,6 +1099,10 @@

Method Details

"password": "A String", # The password for connecting to on-premises instance. "username": "A String", # The username for connecting to on-premises instance. }, + "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend + "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. "region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. @@ -1368,6 +1376,10 @@

Method Details

"password": "A String", # The password for connecting to on-premises instance. "username": "A String", # The username for connecting to on-premises instance. }, + "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend + "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. "region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. @@ -1613,6 +1625,10 @@

Method Details

"password": "A String", # The password for connecting to on-premises instance. "username": "A String", # The username for connecting to on-premises instance. }, + "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend + "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. "region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. @@ -2597,6 +2613,10 @@

Method Details

"password": "A String", # The password for connecting to on-premises instance. "username": "A String", # The username for connecting to on-premises instance. }, + "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend + "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job + }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. "region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. diff --git a/docs/dyn/storagetransfer_v1.transferJobs.html b/docs/dyn/storagetransfer_v1.transferJobs.html index 51c2d76bf35..d1f828d9767 100644 --- a/docs/dyn/storagetransfer_v1.transferJobs.html +++ b/docs/dyn/storagetransfer_v1.transferJobs.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. "lastModificationTime": "A String", # Output only. The time that the transfer job was last modified. "latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if and only if at least one TransferOperation has been created for this JobConfig. - "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. + "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. "notificationConfig": { # Specification to configure notifications published to Cloud Pub/Sub. Notifications will be published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` will contain a TransferOperation resource formatted according to the specified `PayloadFormat`. # Notification configuration. "eventTypes": [ # Event types for which a notification is desired. If empty, send notifications for all event types. "A String", @@ -212,7 +212,7 @@

Method Details

"description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. "lastModificationTime": "A String", # Output only. The time that the transfer job was last modified. "latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if and only if at least one TransferOperation has been created for this JobConfig. - "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. + "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. "notificationConfig": { # Specification to configure notifications published to Cloud Pub/Sub. Notifications will be published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` will contain a TransferOperation resource formatted according to the specified `PayloadFormat`. # Notification configuration. "eventTypes": [ # Event types for which a notification is desired. If empty, send notifications for all event types. "A String", @@ -317,7 +317,7 @@

Method Details

"description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. "lastModificationTime": "A String", # Output only. The time that the transfer job was last modified. "latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if and only if at least one TransferOperation has been created for this JobConfig. - "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. + "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. "notificationConfig": { # Specification to configure notifications published to Cloud Pub/Sub. Notifications will be published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` will contain a TransferOperation resource formatted according to the specified `PayloadFormat`. # Notification configuration. "eventTypes": [ # Event types for which a notification is desired. If empty, send notifications for all event types. "A String", @@ -426,7 +426,7 @@

Method Details

"description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. "lastModificationTime": "A String", # Output only. The time that the transfer job was last modified. "latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if and only if at least one TransferOperation has been created for this JobConfig. - "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. + "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. "notificationConfig": { # Specification to configure notifications published to Cloud Pub/Sub. Notifications will be published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` will contain a TransferOperation resource formatted according to the specified `PayloadFormat`. # Notification configuration. "eventTypes": [ # Event types for which a notification is desired. If empty, send notifications for all event types. "A String", @@ -543,7 +543,7 @@

Method Details

"description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. "lastModificationTime": "A String", # Output only. The time that the transfer job was last modified. "latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if and only if at least one TransferOperation has been created for this JobConfig. - "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. + "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. "notificationConfig": { # Specification to configure notifications published to Cloud Pub/Sub. Notifications will be published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` will contain a TransferOperation resource formatted according to the specified `PayloadFormat`. # Notification configuration. "eventTypes": [ # Event types for which a notification is desired. If empty, send notifications for all event types. "A String", @@ -642,7 +642,7 @@

Method Details

"description": "A String", # A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. "lastModificationTime": "A String", # Output only. The time that the transfer job was last modified. "latestOperationName": "A String", # The name of the most recently started TransferOperation of this JobConfig. Present if and only if at least one TransferOperation has been created for this JobConfig. - "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. + "name": "A String", # A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error. "notificationConfig": { # Specification to configure notifications published to Cloud Pub/Sub. Notifications will be published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` will contain a TransferOperation resource formatted according to the specified `PayloadFormat`. # Notification configuration. "eventTypes": [ # Event types for which a notification is desired. If empty, send notifications for all event types. "A String", diff --git a/docs/dyn/streetviewpublish_v1.photo.html b/docs/dyn/streetviewpublish_v1.photo.html index 9cc72ae5f87..78be52ec1c5 100644 --- a/docs/dyn/streetviewpublish_v1.photo.html +++ b/docs/dyn/streetviewpublish_v1.photo.html @@ -131,7 +131,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, @@ -184,7 +184,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, @@ -267,7 +267,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, @@ -346,7 +346,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, @@ -400,7 +400,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, diff --git a/docs/dyn/streetviewpublish_v1.photos.html b/docs/dyn/streetviewpublish_v1.photos.html index 3ef8b07724d..79036e2dc9c 100644 --- a/docs/dyn/streetviewpublish_v1.photos.html +++ b/docs/dyn/streetviewpublish_v1.photos.html @@ -177,7 +177,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, @@ -246,7 +246,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, @@ -306,7 +306,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, @@ -393,7 +393,7 @@

Method Details

"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. - "latLngPair": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. + "latLngPair": { # 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. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. "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]. }, diff --git a/docs/dyn/tpu_v1.projects.locations.html b/docs/dyn/tpu_v1.projects.locations.html index a61fa52ddca..e03836c7300 100644 --- a/docs/dyn/tpu_v1.projects.locations.html +++ b/docs/dyn/tpu_v1.projects.locations.html @@ -146,7 +146,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/tpu_v1alpha1.projects.locations.html b/docs/dyn/tpu_v1alpha1.projects.locations.html index 390e017854b..f391ecec01d 100644 --- a/docs/dyn/tpu_v1alpha1.projects.locations.html +++ b/docs/dyn/tpu_v1alpha1.projects.locations.html @@ -146,7 +146,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/vision_v1.files.html b/docs/dyn/vision_v1.files.html index 2cfea7e7d9c..4cbb13986f1 100644 --- a/docs/dyn/vision_v1.files.html +++ b/docs/dyn/vision_v1.files.html @@ -113,11 +113,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -467,7 +467,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -506,7 +506,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -567,7 +567,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -678,7 +678,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -785,11 +785,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1.images.html b/docs/dyn/vision_v1.images.html index a2bcf5c1716..f0494beb83c 100644 --- a/docs/dyn/vision_v1.images.html +++ b/docs/dyn/vision_v1.images.html @@ -120,11 +120,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -446,7 +446,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -485,7 +485,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -546,7 +546,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -657,7 +657,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -774,11 +774,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1.projects.files.html b/docs/dyn/vision_v1.projects.files.html index d92e392ee0d..2a9435b61c5 100644 --- a/docs/dyn/vision_v1.projects.files.html +++ b/docs/dyn/vision_v1.projects.files.html @@ -114,11 +114,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -468,7 +468,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -507,7 +507,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -568,7 +568,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -679,7 +679,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -787,11 +787,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1.projects.images.html b/docs/dyn/vision_v1.projects.images.html index 90bcdd7c1f8..ef670557e25 100644 --- a/docs/dyn/vision_v1.projects.images.html +++ b/docs/dyn/vision_v1.projects.images.html @@ -121,11 +121,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -447,7 +447,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -486,7 +486,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -547,7 +547,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -658,7 +658,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -776,11 +776,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1.projects.locations.files.html b/docs/dyn/vision_v1.projects.locations.files.html index 09acdd97cf2..542bbad3eb6 100644 --- a/docs/dyn/vision_v1.projects.locations.files.html +++ b/docs/dyn/vision_v1.projects.locations.files.html @@ -114,11 +114,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -468,7 +468,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -507,7 +507,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -568,7 +568,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -679,7 +679,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -787,11 +787,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1.projects.locations.images.html b/docs/dyn/vision_v1.projects.locations.images.html index 632a024b485..b52800dc62a 100644 --- a/docs/dyn/vision_v1.projects.locations.images.html +++ b/docs/dyn/vision_v1.projects.locations.images.html @@ -121,11 +121,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -447,7 +447,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -486,7 +486,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -547,7 +547,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -658,7 +658,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -776,11 +776,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p1beta1.files.html b/docs/dyn/vision_v1p1beta1.files.html index 757b0a011f4..f155153b3a2 100644 --- a/docs/dyn/vision_v1p1beta1.files.html +++ b/docs/dyn/vision_v1p1beta1.files.html @@ -113,11 +113,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -467,7 +467,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -506,7 +506,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -567,7 +567,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -678,7 +678,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -785,11 +785,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p1beta1.images.html b/docs/dyn/vision_v1p1beta1.images.html index 2c0ce39617f..0633b592db8 100644 --- a/docs/dyn/vision_v1p1beta1.images.html +++ b/docs/dyn/vision_v1p1beta1.images.html @@ -120,11 +120,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -446,7 +446,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -485,7 +485,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -546,7 +546,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -657,7 +657,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -774,11 +774,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p1beta1.projects.files.html b/docs/dyn/vision_v1p1beta1.projects.files.html index c0d9f39295b..2378a429c89 100644 --- a/docs/dyn/vision_v1p1beta1.projects.files.html +++ b/docs/dyn/vision_v1p1beta1.projects.files.html @@ -114,11 +114,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -468,7 +468,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -507,7 +507,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -568,7 +568,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -679,7 +679,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -787,11 +787,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p1beta1.projects.images.html b/docs/dyn/vision_v1p1beta1.projects.images.html index ba6f51c111e..b2eb9ecd471 100644 --- a/docs/dyn/vision_v1p1beta1.projects.images.html +++ b/docs/dyn/vision_v1p1beta1.projects.images.html @@ -121,11 +121,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -447,7 +447,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -486,7 +486,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -547,7 +547,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -658,7 +658,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -776,11 +776,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p1beta1.projects.locations.files.html b/docs/dyn/vision_v1p1beta1.projects.locations.files.html index b1eb9a84d8a..19049495394 100644 --- a/docs/dyn/vision_v1p1beta1.projects.locations.files.html +++ b/docs/dyn/vision_v1p1beta1.projects.locations.files.html @@ -114,11 +114,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -468,7 +468,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -507,7 +507,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -568,7 +568,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -679,7 +679,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -787,11 +787,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p1beta1.projects.locations.images.html b/docs/dyn/vision_v1p1beta1.projects.locations.images.html index dbbe33940e7..74a45b7253f 100644 --- a/docs/dyn/vision_v1p1beta1.projects.locations.images.html +++ b/docs/dyn/vision_v1p1beta1.projects.locations.images.html @@ -121,11 +121,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -447,7 +447,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -486,7 +486,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -547,7 +547,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -658,7 +658,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -776,11 +776,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p2beta1.files.html b/docs/dyn/vision_v1p2beta1.files.html index b71590bb37c..f773fa12b76 100644 --- a/docs/dyn/vision_v1p2beta1.files.html +++ b/docs/dyn/vision_v1p2beta1.files.html @@ -113,11 +113,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -467,7 +467,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -506,7 +506,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -567,7 +567,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -678,7 +678,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -785,11 +785,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p2beta1.images.html b/docs/dyn/vision_v1p2beta1.images.html index e6f4593de68..daf568436e7 100644 --- a/docs/dyn/vision_v1p2beta1.images.html +++ b/docs/dyn/vision_v1p2beta1.images.html @@ -120,11 +120,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -446,7 +446,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -485,7 +485,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -546,7 +546,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -657,7 +657,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -774,11 +774,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p2beta1.projects.files.html b/docs/dyn/vision_v1p2beta1.projects.files.html index 3c3250c373c..980ef73a38d 100644 --- a/docs/dyn/vision_v1p2beta1.projects.files.html +++ b/docs/dyn/vision_v1p2beta1.projects.files.html @@ -114,11 +114,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -468,7 +468,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -507,7 +507,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -568,7 +568,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -679,7 +679,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -787,11 +787,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p2beta1.projects.images.html b/docs/dyn/vision_v1p2beta1.projects.images.html index a2decfa55b8..ffb6c57fc2d 100644 --- a/docs/dyn/vision_v1p2beta1.projects.images.html +++ b/docs/dyn/vision_v1p2beta1.projects.images.html @@ -121,11 +121,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -447,7 +447,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -486,7 +486,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -547,7 +547,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -658,7 +658,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -776,11 +776,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p2beta1.projects.locations.files.html b/docs/dyn/vision_v1p2beta1.projects.locations.files.html index adffd4698da..d319ff0a4cf 100644 --- a/docs/dyn/vision_v1p2beta1.projects.locations.files.html +++ b/docs/dyn/vision_v1p2beta1.projects.locations.files.html @@ -114,11 +114,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -468,7 +468,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -507,7 +507,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -568,7 +568,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -679,7 +679,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -787,11 +787,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/vision_v1p2beta1.projects.locations.images.html b/docs/dyn/vision_v1p2beta1.projects.locations.images.html index 65c92b2c409..54d74a74df9 100644 --- a/docs/dyn/vision_v1p2beta1.projects.locations.images.html +++ b/docs/dyn/vision_v1p2beta1.projects.locations.images.html @@ -121,11 +121,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, @@ -447,7 +447,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -486,7 +486,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -547,7 +547,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -658,7 +658,7 @@

Method Details

"locale": "A String", # The language code for the locale in which the entity textual `description` is expressed. "locations": [ # The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. { # Detected entity location information. - "latLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # lat/long location coordinates. + "latLng": { # 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. # lat/long location coordinates. "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]. }, @@ -776,11 +776,11 @@

Method Details

"A String", ], "latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used. - "maxLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Max lat/long pair. + "maxLatLng": { # 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. # Max lat/long pair. "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]. }, - "minLatLng": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # Min lat/long pair. + "minLatLng": { # 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. # Min lat/long pair. "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]. }, diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html index db5853e45a5..aec805b49a0 100644 --- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html +++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html @@ -140,6 +140,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only. "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. @@ -185,6 +186,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only. "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. @@ -255,6 +257,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only. "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. @@ -312,6 +315,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only. "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. @@ -375,6 +379,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only. "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. @@ -421,6 +426,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only. "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html index 5a11d23698a..392244399e5 100644 --- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html +++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html @@ -140,6 +140,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available. "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. @@ -212,6 +213,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available. "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. @@ -309,6 +311,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available. "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. @@ -393,6 +396,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available. "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. @@ -483,6 +487,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available. "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. @@ -556,6 +561,7 @@

Method Details

], "displayName": "A String", # Required. The user provided display name of the ScanConfig. "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center. + "ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes. "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 # Latest ScanRun if available. "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. diff --git a/docs/dyn/workflows_v1.projects.locations.html b/docs/dyn/workflows_v1.projects.locations.html index 7ce86dcb3bc..b771c2a3b67 100644 --- a/docs/dyn/workflows_v1.projects.locations.html +++ b/docs/dyn/workflows_v1.projects.locations.html @@ -136,7 +136,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json b/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json index f4dc6df3b6d..f80bb494e12 100644 --- a/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json +++ b/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json @@ -139,7 +139,7 @@ } } }, - "revision": "20210329", + "revision": "20210423", "rootUrl": "https://abusiveexperiencereport.googleapis.com/", "schemas": { "SiteSummaryResponse": { diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index f189809cf5e..7a732bfac70 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "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 55f6489baab..e32057c27d6 100644 --- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json +++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json @@ -754,7 +754,7 @@ } } }, - "revision": "20210402", + "revision": "20210423", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalSettings": { @@ -935,7 +935,7 @@ "id": "EnrolledService", "properties": { "cloudProduct": { - "description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * App Engine * BigQuery * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Dataflow * Cloud Identity and Access Management * Cloud Logging * Cloud Pub/Sub * Cloud Spanner * Cloud Storage * Persistent Disk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * appengine.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * cloudkms.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * iam.googleapis.com * logging.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services", + "description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * App Engine * BigQuery * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Dataflow * Cloud Identity and Access Management * Cloud Logging * Cloud Pub/Sub * Cloud Spanner * Cloud Storage * Google Kubernetes Engine * Persistent Disk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * appengine.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * iam.googleapis.com * logging.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services", "type": "string" }, "enrollmentLevel": { diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index ee03a05ba54..45e75f0c1b8 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -943,7 +943,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessLevel": { @@ -1190,7 +1190,7 @@ "type": "object" }, "EgressFrom": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", "id": "EgressFrom", "properties": { "identities": { @@ -1235,18 +1235,18 @@ "type": "object" }, "EgressTo": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.", "id": "EgressTo", "properties": { "operations": { - "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.", "items": { "$ref": "ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.", "items": { "type": "string" }, @@ -1307,7 +1307,7 @@ "type": "object" }, "IngressFrom": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "IngressFrom", "properties": { "identities": { @@ -1363,7 +1363,7 @@ "id": "IngressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, "resource": { @@ -1374,18 +1374,18 @@ "type": "object" }, "IngressTo": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.", "id": "IngressTo", "properties": { "operations": { - "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.", "items": { "$ref": "ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json index 254b5597373..66fd0c39196 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json @@ -609,7 +609,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessLevel": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer.v12.json b/googleapiclient/discovery_cache/documents/adexchangebuyer.v12.json index e0fb4d45ea3..ac9b9c67fbb 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer.v12.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer.v12.json @@ -15,7 +15,7 @@ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/I5uvmjpiTkAMB8SKDsE5kjSNgps\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/ukBkDhGpFRX0glPlPv72lN7vM7A\"", "icons": { "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" @@ -259,7 +259,7 @@ } } }, - "revision": "20210411", + "revision": "20210426", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer.v13.json b/googleapiclient/discovery_cache/documents/adexchangebuyer.v13.json index 758c648be9c..3a814cb7ddf 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer.v13.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer.v13.json @@ -15,7 +15,7 @@ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/ljUtzRlxnt4BcmOVhMUOCX67DRI\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/3hTwwo7tL9S6udrSxgtufTbqHSk\"", "icons": { "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" @@ -699,7 +699,7 @@ } } }, - "revision": "20210411", + "revision": "20210426", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer.v14.json b/googleapiclient/discovery_cache/documents/adexchangebuyer.v14.json index 05f35404410..7c264f06bbb 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer.v14.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer.v14.json @@ -15,7 +15,7 @@ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/HQCWZMBMitynZmjs9SgGCUW6BQc\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/U1-gfkQn_V3cBC0YDFnUCDnCfBE\"", "icons": { "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" @@ -1255,7 +1255,7 @@ } } }, - "revision": "20210411", + "revision": "20210426", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index 1c27330b450..f774e0bd133 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -2500,7 +2500,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { @@ -4082,7 +4082,7 @@ "Financial service ad does not adhere to specifications.", "Flash content was found in an unsupported context.", "Misuse by an Open Measurement SDK script.", - "Use of an Open Measurement SDK vendor not on approved whitelist.", + "Use of an Open Measurement SDK vendor not on approved vendor list.", "Unacceptable landing page.", "Unsupported language.", "Non-SSL compliant.", @@ -4373,10 +4373,34 @@ "format": "int64", "type": "string" }, + "impressionCap": { + "description": "The lifetime impression cap for CPM sponsorship deals. The deal will stop serving when the cap is reached.", + "format": "int64", + "type": "string" + }, "minimumDailyLooks": { "description": "Daily minimum looks for CPD deal types.", "format": "int64", "type": "string" + }, + "percentShareOfVoice": { + "description": "For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached.", + "format": "int64", + "type": "string" + }, + "reservationType": { + "description": "The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.", + "enum": [ + "RESERVATION_TYPE_UNSPECIFIED", + "STANDARD", + "SPONSORSHIP" + ], + "enumDescriptions": [ + "An unspecified reservation type.", + "Non-sponsorship deal.", + "Sponsorship deals don't have impression goal (guaranteed_looks) and they are served based on the flight dates. For CPM Sponsorship deals, impression_cap is the lifetime impression limit." + ], + "type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json b/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json index 66c7a88af21..2030d4a4d40 100644 --- a/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json +++ b/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json @@ -138,7 +138,7 @@ } } }, - "revision": "20210329", + "revision": "20210423", "rootUrl": "https://adexperiencereport.googleapis.com/", "schemas": { "PlatformSummary": { diff --git a/googleapiclient/discovery_cache/documents/admin.datatransferv1.json b/googleapiclient/discovery_cache/documents/admin.datatransferv1.json index d27fe22682c..a98c7c1c517 100644 --- a/googleapiclient/discovery_cache/documents/admin.datatransferv1.json +++ b/googleapiclient/discovery_cache/documents/admin.datatransferv1.json @@ -272,7 +272,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/admin.directoryv1.json b/googleapiclient/discovery_cache/documents/admin.directoryv1.json index 2a417de3643..b19b374782a 100644 --- a/googleapiclient/discovery_cache/documents/admin.directoryv1.json +++ b/googleapiclient/discovery_cache/documents/admin.directoryv1.json @@ -4164,6 +4164,19 @@ "userKey" ], "parameters": { + "event": { + "description": "Events to watch for.", + "enum": [ + "add", + "delete" + ], + "enumDescriptions": [ + "Alias Created Event", + "Alias Deleted Event" + ], + "location": "query", + "type": "string" + }, "userKey": { "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", @@ -4404,7 +4417,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5717,7 +5730,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", @@ -6552,6 +6565,7 @@ "type": "object" }, "RoleAssignment": { + "description": "Defines an assignment of a role.", "id": "RoleAssignment", "properties": { "assignedTo": { diff --git a/googleapiclient/discovery_cache/documents/admin.reportsv1.json b/googleapiclient/discovery_cache/documents/admin.reportsv1.json index 754a51f9111..17c042f3273 100644 --- a/googleapiclient/discovery_cache/documents/admin.reportsv1.json +++ b/googleapiclient/discovery_cache/documents/admin.reportsv1.json @@ -148,7 +148,8 @@ "user_accounts", "context_aware_access", "chrome", - "data_studio" + "data_studio", + "keep" ], "enumDescriptions": [ "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.", @@ -170,10 +171,11 @@ "The User Accounts application's activity reports return account information about different types of User Accounts activity events.", "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.", "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.", - "The Data Studio activity reports return information about various types of Data Studio activity events." + "The Data Studio activity reports return information about various types of Data Studio activity events.", + "The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers." ], "location": "path", - "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)", + "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)", "required": true, "type": "string" }, @@ -285,7 +287,8 @@ "user_accounts", "context_aware_access", "chrome", - "data_studio" + "data_studio", + "keep" ], "enumDescriptions": [ "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.", @@ -307,10 +310,11 @@ "The User Accounts application's activity reports return account information about different types of User Accounts activity events.", "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.", "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.", - "The Data Studio activity reports return information about various types of Data Studio activity events." + "The Data Studio activity reports return information about various types of Data Studio activity events.", + "The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers." ], "location": "path", - "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)", + "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)", "required": true, "type": "string" }, @@ -627,7 +631,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "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 d555b88c7d3..cb7278c27b3 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -168,6 +168,88 @@ } }, "resources": { + "adUnits": { + "methods": { + "list": { + "description": "List the ad units under the specified AdMob account.", + "flatPath": "v1/accounts/{accountsId}/adUnits", + "httpMethod": "GET", + "id": "admob.accounts.adUnits.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of ad units to return. If unspecified or 0, at most 1000 ad units will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListAdUnitsResponse`; indicates that this is a continuation of a prior `ListAdUnits` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/adUnits", + "response": { + "$ref": "ListAdUnitsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/admob.readonly" + ], + "streamingType": "NONE" + } + } + }, + "apps": { + "methods": { + "list": { + "description": "List the apps under the specified AdMob account.", + "flatPath": "v1/accounts/{accountsId}/apps", + "httpMethod": "GET", + "id": "admob.accounts.apps.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of apps to return. If unspecified or 0, at most 1000 apps will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListAppsResponse`; indicates that this is a continuation of a prior `ListApps` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apps", + "response": { + "$ref": "ListAppsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/admob.readonly" + ], + "streamingType": "NONE" + } + } + }, "mediationReport": { "methods": { "generate": { @@ -239,9 +321,97 @@ } } }, - "revision": "20210412", + "revision": "20210427", "rootUrl": "https://admob.googleapis.com/", "schemas": { + "AdUnit": { + "description": "Describes an AdMob ad unit.", + "id": "AdUnit", + "properties": { + "adFormat": { + "description": "AdFormat of the ad unit. Possible values are as follows: \"BANNER\" - Banner ad format. \"BANNER_INTERSTITIAL\" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. \"INTERSTITIAL\" - A full screen ad. Supported ad types are \"RICH_MEDIA\" and \"VIDEO\". \"NATIVE\" - Native ad format. \"REWARDED\" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are \"RICH_MEDIA\" (interactive) and video where video can not be excluded.", + "type": "string" + }, + "adTypes": { + "description": "Ad media type supported by this ad unit. Possible values as follows: \"RICH_MEDIA\" - Text, image, and other non-video media. \"VIDEO\" - Video media.", + "items": { + "type": "string" + }, + "type": "array" + }, + "adUnitId": { + "description": "The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789", + "type": "string" + }, + "appId": { + "description": "The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789", + "type": "string" + }, + "displayName": { + "description": "The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.", + "type": "string" + }, + "name": { + "description": "Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789", + "type": "string" + } + }, + "type": "object" + }, + "App": { + "description": "Describes an AdMob app for a specific platform (For example: Android or iOS).", + "id": "App", + "properties": { + "appId": { + "description": "The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789", + "type": "string" + }, + "linkedAppInfo": { + "$ref": "AppLinkedAppInfo", + "description": "Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store." + }, + "manualAppInfo": { + "$ref": "AppManualAppInfo", + "description": "The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used." + }, + "name": { + "description": "Resource name for this app. Format is accounts/{publisher_id}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789", + "type": "string" + }, + "platform": { + "description": "Describes the platform of the app. Limited to \"IOS\" and \"ANDROID\".", + "type": "string" + } + }, + "type": "object" + }, + "AppLinkedAppInfo": { + "description": "Information from the app store if the app is linked to an app store.", + "id": "AppLinkedAppInfo", + "properties": { + "appStoreId": { + "description": "The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: \"com.example.myapp\". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example \"105169111\". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked.", + "type": "string" + }, + "displayName": { + "description": "Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AppManualAppInfo": { + "description": "Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).", + "id": "AppManualAppInfo", + "properties": { + "displayName": { + "description": "The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.", + "type": "string" + } + }, + "type": "object" + }, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", @@ -339,6 +509,42 @@ }, "type": "object" }, + "ListAdUnitsResponse": { + "description": "Response for the ad units list request.", + "id": "ListAdUnitsResponse", + "properties": { + "adUnits": { + "description": "The resulting ad units for the requested account.", + "items": { + "$ref": "AdUnit" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`.", + "type": "string" + } + }, + "type": "object" + }, + "ListAppsResponse": { + "description": "Response for the apps list request.", + "id": "ListAppsResponse", + "properties": { + "apps": { + "description": "The resulting apps for the requested account.", + "items": { + "$ref": "App" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If not empty, indicates that there may be more apps for the request; this value should be passed in a new `ListAppsRequest`.", + "type": "string" + } + }, + "type": "object" + }, "ListPublisherAccountsResponse": { "description": "Response for the publisher account list request.", "id": "ListPublisherAccountsResponse", diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index 343e590fb99..68e8a3812f2 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -321,7 +321,7 @@ } } }, - "revision": "20210412", + "revision": "20210427", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json new file mode 100644 index 00000000000..b48d60de0b2 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -0,0 +1,2273 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/adsense": { + "description": "View and manage your AdSense data" + }, + "https://www.googleapis.com/auth/adsense.readonly": { + "description": "View your AdSense data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://adsense.googleapis.com/", + "batchPath": "batch", + "description": "The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.", + "discoveryVersion": "v1", + "documentationLink": "http://code.google.com/apis/adsense/management/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "adsense:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://adsense.mtls.googleapis.com/", + "name": "adsense", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "accounts": { + "methods": { + "get": { + "description": "Gets information about the selected AdSense account.", + "flatPath": "v2/accounts/{accountsId}", + "httpMethod": "GET", + "id": "adsense.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account to get information about. Format: accounts/{account_id}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists all accounts available to this user.", + "flatPath": "v2/accounts", + "httpMethod": "GET", + "id": "adsense.accounts.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/accounts", + "response": { + "$ref": "ListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "listChildAccounts": { + "description": "Lists all accounts directly managed by the given AdSense account.", + "flatPath": "v2/accounts/{accountsId}:listChildAccounts", + "httpMethod": "GET", + "id": "adsense.accounts.listChildAccounts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent account, which owns the child accounts. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}:listChildAccounts", + "response": { + "$ref": "ListChildAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + }, + "resources": { + "adclients": { + "methods": { + "getAdcode": { + "description": "Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adcode", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.getAdcode", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the ad client for which to get the adcode. Format: accounts/{account}/adclients/{adclient}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}/adcode", + "response": { + "$ref": "AdClientAdCode" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists all the ad clients available in an account.", + "flatPath": "v2/accounts/{accountsId}/adclients", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account which owns the collection of ad clients. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/adclients", + "response": { + "$ref": "ListAdClientsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + }, + "resources": { + "adunits": { + "methods": { + "get": { + "description": "Gets an ad unit from a specified account and ad client.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.adunits.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. AdUnit to get information about. Format: accounts/{account_id}/adclient/{adclient_id}/adunit/{adunit_id}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+/adunits/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "AdUnit" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "getAdcode": { + "description": "Gets the AdSense code for a given ad unit.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}/adcode", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.adunits.getAdcode", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+/adunits/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}/adcode", + "response": { + "$ref": "AdUnitAdCode" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists all ad units under a specified account and ad client.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.adunits.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/adunits", + "response": { + "$ref": "ListAdUnitsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "listLinkedCustomChannels": { + "description": "Lists all the custom channels available for an ad unit.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}:listLinkedCustomChannels", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.adunits.listLinkedCustomChannels", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedCustomChannels` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The ad unit which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+/adunits/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}:listLinkedCustomChannels", + "response": { + "$ref": "ListLinkedCustomChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + } + }, + "customchannels": { + "methods": { + "get": { + "description": "Gets information about the selected custom channel.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.customchannels.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+/customchannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "CustomChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists all the custom channels available in an ad client.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.customchannels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/customchannels", + "response": { + "$ref": "ListCustomChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "listLinkedAdUnits": { + "description": "Lists all the ad units available for a custom channel.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}:listLinkedAdUnits", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.customchannels.listLinkedAdUnits", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+/customchannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}:listLinkedAdUnits", + "response": { + "$ref": "ListLinkedAdUnitsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + } + }, + "urlchannels": { + "methods": { + "list": { + "description": "Lists active url channels.", + "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/urlchannels", + "httpMethod": "GET", + "id": "adsense.accounts.adclients.urlchannels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListUrlChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUrlChannels` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient}", + "location": "path", + "pattern": "^accounts/[^/]+/adclients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/urlchannels", + "response": { + "$ref": "ListUrlChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + } + } + } + }, + "alerts": { + "methods": { + "list": { + "description": "Lists all the alerts available in an account.", + "flatPath": "v2/accounts/{accountsId}/alerts", + "httpMethod": "GET", + "id": "adsense.accounts.alerts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account which owns the collection of alerts. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/alerts", + "response": { + "$ref": "ListAlertsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + } + }, + "payments": { + "methods": { + "list": { + "description": "Lists all the payments available for an account.", + "flatPath": "v2/accounts/{accountsId}/payments", + "httpMethod": "GET", + "id": "adsense.accounts.payments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account which owns the collection of payments. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/payments", + "response": { + "$ref": "ListPaymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + } + }, + "reports": { + "methods": { + "generate": { + "description": "Generates an ad hoc report.", + "flatPath": "v2/accounts/{accountsId}/reports:generate", + "httpMethod": "GET", + "id": "adsense.accounts.reports.generate", + "parameterOrder": [ + "account" + ], + "parameters": { + "account": { + "description": "Required. The account which owns the collection of reports. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + }, + "currencyCode": { + "description": "The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.", + "location": "query", + "type": "string" + }, + "dateRange": { + "description": "Date range of the report, if unset the range will be considered CUSTOM.", + "enum": [ + "REPORTING_DATE_RANGE_UNSPECIFIED", + "CUSTOM", + "TODAY", + "YESTERDAY", + "MONTH_TO_DATE", + "YEAR_TO_DATE", + "LAST_7_DAYS", + "LAST_30_DAYS" + ], + "enumDescriptions": [ + "Unspecified date range.", + "A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.", + "Current day.", + "Yesterday.", + "From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].", + "From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].", + "Last 7 days, excluding current day.", + "Last 30 days, excluding current day." + ], + "location": "query", + "type": "string" + }, + "dimensions": { + "description": "Dimensions to base the report on.", + "enum": [ + "DIMENSION_UNSPECIFIED", + "DATE", + "WEEK", + "MONTH", + "ACCOUNT_NAME", + "AD_CLIENT_ID", + "PRODUCT_NAME", + "PRODUCT_CODE", + "AD_UNIT_NAME", + "AD_UNIT_ID", + "AD_UNIT_SIZE_NAME", + "AD_UNIT_SIZE_CODE", + "CUSTOM_CHANNEL_NAME", + "CUSTOM_CHANNEL_ID", + "OWNED_SITE_DOMAIN_NAME", + "OWNED_SITE_ID", + "URL_CHANNEL_NAME", + "URL_CHANNEL_ID", + "BUYER_NETWORK_NAME", + "BUYER_NETWORK_ID", + "BID_TYPE_NAME", + "BID_TYPE_CODE", + "CREATIVE_SIZE_NAME", + "CREATIVE_SIZE_CODE", + "DOMAIN_NAME", + "DOMAIN_CODE", + "COUNTRY_NAME", + "COUNTRY_CODE", + "PLATFORM_TYPE_NAME", + "PLATFORM_TYPE_CODE", + "TARGETING_TYPE_NAME", + "TARGETING_TYPE_CODE", + "CONTENT_PLATFORM_NAME", + "CONTENT_PLATFORM_CODE", + "AD_PLACEMENT_NAME", + "AD_PLACEMENT_CODE", + "REQUESTED_AD_TYPE_NAME", + "REQUESTED_AD_TYPE_CODE", + "SERVED_AD_TYPE_NAME", + "SERVED_AD_TYPE_CODE", + "CUSTOM_SEARCH_STYLE_NAME", + "CUSTOM_SEARCH_STYLE_ID", + "DOMAIN_REGISTRANT", + "WEBSEARCH_QUERY_STRING" + ], + "enumDescriptions": [ + "Unspecified dimension.", + "Date dimension in YYYY-MM-DD format (e.g. \"2010-02-10\").", + "Week dimension in YYYY-MM-DD format, representing the first day of each week (e.g. \"2010-02-08\"). The first day of the week is determined by the language_code specified in a report generation request (so e.g. this would be a Monday for \"en-GB\" or \"es\", but a Sunday for \"en\" or \"fr-CA\").", + "Month dimension in YYYY-MM format (e.g. \"2010-02\").", + "Account name. The members of this dimension match the values from Account.display_name.", + "Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id.", + "Localized product name (e.g. \"AdSense for Content\", \"AdSense for Search\").", + "Product code (e.g. \"AFC\", \"AFS\"). The members of this dimension match the values from AdClient.product_code.", + "Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name.", + "Unique ID of an ad unit (within which an ad was served). The members of this dimension match the values from AdUnit.reporting_dimension_id.", + "Localized size of an ad unit (e.g. \"728x90\", \"Responsive\").", + "The size code of an ad unit (e.g. \"728x90\", \"responsive\").", + "Custom channel name. The members of this dimension match the values from CustomChannel.display_name.", + "Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.", + "Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.", + "Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.", + "Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.", + "Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.", + "Name of an ad network that returned the winning ads for an ad request (e.g. \"Google AdWords\"). Note that unlike other \"NAME\" dimensions, the members of this dimensions are not localized.", + "Unique (opaque) ID of an ad network that returned the winning ads for an ad request.", + "Localized bid type name (e.g. \"CPC bids\", \"CPM bids\") for a served ad.", + "Type of a bid (e.g. \"cpc\", \"cpm\") for a served ad.", + "Localized creative size name (e.g. \"728x90\", \"Dynamic\") of a served ad.", + "Creative size code (e.g. \"728x90\", \"dynamic\") of a served ad.", + "Localized name of a host on which an ad was served, after IDNA decoding (e.g. \"www.google.com\", \"Web caches and other\", \"b\u00fccher.example\").", + "Name of a host on which an ad was served (e.g. \"www.google.com\", \"webcaches\", \"xn--bcher-kva.example\").", + "Localized region name of a user viewing an ad (e.g. \"United States\", \"France\").", + "CLDR region code of a user viewing an ad (e.g. \"US\", \"FR\").", + "Localized platform type name (e.g. \"High-end mobile devices\", \"Desktop\").", + "Platform type code (e.g. \"HighEndMobile\", \"Desktop\").", + "Localized targeting type name (e.g. \"Contextual\", \"Personalized\", \"Run of Network\").", + "Targeting type code (e.g. \"Keyword\", \"UserInterest\", \"RunOfNetwork\").", + "Localized content platform name an ad request was made from (e.g. \"AMP\", \"Web\").", + "Content platform code an ad request was made from (e.g. \"AMP\", \"HTML\").", + "Localized ad placement name (e.g. \"Ad unit\", \"Global settings\", \"Manual\").", + "Ad placement code (e.g. \"AD_UNIT\", \"ca-pub-123456:78910\", \"OTHER\").", + "Localized requested ad type name (e.g. \"Display\", \"Link unit\", \"Other\").", + "Requested ad type code (e.g. \"IMAGE\", \"RADLINK\", \"OTHER\").", + "Localized served ad type name (e.g. \"Display\", \"Link unit\", \"Other\").", + "Served ad type code (e.g. \"IMAGE\", \"RADLINK\", \"OTHER\").", + "Custom search style name.", + "Custom search style id.", + "Domain registrants.", + "Query strings for web searches." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "endDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "filters": { + "description": "Filters to be run on the report.", + "location": "query", + "repeated": true, + "type": "string" + }, + "languageCode": { + "description": "The language to use for translating report output. If unspecified, this defaults to English (\"en\"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).", + "location": "query", + "type": "string" + }, + "limit": { + "description": "The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "metrics": { + "description": "Required. Reporting metrics.", + "enum": [ + "METRIC_UNSPECIFIED", + "PAGE_VIEWS", + "AD_REQUESTS", + "MATCHED_AD_REQUESTS", + "TOTAL_IMPRESSIONS", + "IMPRESSIONS", + "INDIVIDUAL_AD_IMPRESSIONS", + "CLICKS", + "PAGE_VIEWS_SPAM_RATIO", + "AD_REQUESTS_SPAM_RATIO", + "MATCHED_AD_REQUESTS_SPAM_RATIO", + "IMPRESSIONS_SPAM_RATIO", + "INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO", + "CLICKS_SPAM_RATIO", + "AD_REQUESTS_COVERAGE", + "PAGE_VIEWS_CTR", + "AD_REQUESTS_CTR", + "MATCHED_AD_REQUESTS_CTR", + "IMPRESSIONS_CTR", + "INDIVIDUAL_AD_IMPRESSIONS_CTR", + "ACTIVE_VIEW_MEASURABILITY", + "ACTIVE_VIEW_VIEWABILITY", + "ACTIVE_VIEW_TIME", + "ESTIMATED_EARNINGS", + "PAGE_VIEWS_RPM", + "AD_REQUESTS_RPM", + "MATCHED_AD_REQUESTS_RPM", + "IMPRESSIONS_RPM", + "INDIVIDUAL_AD_IMPRESSIONS_RPM", + "COST_PER_CLICK", + "ADS_PER_IMPRESSION", + "TOTAL_EARNINGS", + "WEBSEARCH_RESULT_PAGES" + ], + "enumDescriptions": [ + "Unspecified metric.", + "Number of page views.", + "Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available.", + "Requests that returned at least one ad.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user\u2019s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user\u2019s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads.", + "Number of times a user clicked on a standard content ad.", + "Fraction of page views considered to be spam. Only available to premium accounts.", + "Fraction of ad requests considered to be spam. Only available to premium accounts.", + "Fraction of ad requests that returned ads considered to be spam. Only available to premium accounts.", + "Fraction of impressions considered to be spam. Only available to premium accounts.", + "Fraction of ad impressions considered to be spam. Only available to premium accounts.", + "Fraction of clicks considered to be spam. Only available to premium accounts.", + "Ratio of requested ad units or queries to the number returned to the site.", + "Ratio of individual page views that resulted in a click.", + "Ratio of ad requests that resulted in a click.", + "Ratio of clicks to matched requests.", + "Ratio of IMPRESSIONS that resulted in a click.", + "Ratio of individual ad impressions that resulted in a click.", + "Ratio of requests that were measurable for viewability.", + "Ratio of requests that were viewable.", + "Mean time an ad was displayed on screen.", + "Estimated earnings of the publisher. Note that earnings up to yesterday are accurate, more recent earnings are estimated due to the possibility of spam, or exchange rate fluctuations.", + "Revenue per thousand page views. This is calculated by dividing the estimated revenue by the number of page views multiplied by 1000.", + "Revenue per thousand ad requests. This is calculated by dividing estimated revenue by the number of ad requests multiplied by 1000.", + "Revenue per thousand matched ad requests. This is calculated by dividing estimated revenue by the number of matched ad requests multiplied by 1000.", + "Revenue per thousand ad impressions. This is calculated by dividing estimated revenue by the number of ad impressions multiplied by 1000.", + "Revenue per thousand individual ad impressions. This is calculated by dividing estimated revenue by the number of individual ad impressions multiplied by 1000.", + "Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.", + "Number of ad views per impression.", + "Total earnings.", + "Number of results pages." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "orderBy": { + "description": "The name of a dimension or metric to sort the resulting report on, can be prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.", + "location": "query", + "repeated": true, + "type": "string" + }, + "reportingTimeZone": { + "description": "Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).", + "enum": [ + "REPORTING_TIME_ZONE_UNSPECIFIED", + "ACCOUNT_TIME_ZONE", + "GOOGLE_TIME_ZONE" + ], + "enumDescriptions": [ + "Unspecified timezone.", + "Use the account timezone in the report.", + "Use the Google timezone in the report (America/Los_Angeles)." + ], + "location": "query", + "type": "string" + }, + "startDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v2/{+account}/reports:generate", + "response": { + "$ref": "ReportResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "generateCsv": { + "description": "Generates a csv formatted ad hoc report.", + "flatPath": "v2/accounts/{accountsId}/reports:generateCsv", + "httpMethod": "GET", + "id": "adsense.accounts.reports.generateCsv", + "parameterOrder": [ + "account" + ], + "parameters": { + "account": { + "description": "Required. The account which owns the collection of reports. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + }, + "currencyCode": { + "description": "The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.", + "location": "query", + "type": "string" + }, + "dateRange": { + "description": "Date range of the report, if unset the range will be considered CUSTOM.", + "enum": [ + "REPORTING_DATE_RANGE_UNSPECIFIED", + "CUSTOM", + "TODAY", + "YESTERDAY", + "MONTH_TO_DATE", + "YEAR_TO_DATE", + "LAST_7_DAYS", + "LAST_30_DAYS" + ], + "enumDescriptions": [ + "Unspecified date range.", + "A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.", + "Current day.", + "Yesterday.", + "From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].", + "From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].", + "Last 7 days, excluding current day.", + "Last 30 days, excluding current day." + ], + "location": "query", + "type": "string" + }, + "dimensions": { + "description": "Dimensions to base the report on.", + "enum": [ + "DIMENSION_UNSPECIFIED", + "DATE", + "WEEK", + "MONTH", + "ACCOUNT_NAME", + "AD_CLIENT_ID", + "PRODUCT_NAME", + "PRODUCT_CODE", + "AD_UNIT_NAME", + "AD_UNIT_ID", + "AD_UNIT_SIZE_NAME", + "AD_UNIT_SIZE_CODE", + "CUSTOM_CHANNEL_NAME", + "CUSTOM_CHANNEL_ID", + "OWNED_SITE_DOMAIN_NAME", + "OWNED_SITE_ID", + "URL_CHANNEL_NAME", + "URL_CHANNEL_ID", + "BUYER_NETWORK_NAME", + "BUYER_NETWORK_ID", + "BID_TYPE_NAME", + "BID_TYPE_CODE", + "CREATIVE_SIZE_NAME", + "CREATIVE_SIZE_CODE", + "DOMAIN_NAME", + "DOMAIN_CODE", + "COUNTRY_NAME", + "COUNTRY_CODE", + "PLATFORM_TYPE_NAME", + "PLATFORM_TYPE_CODE", + "TARGETING_TYPE_NAME", + "TARGETING_TYPE_CODE", + "CONTENT_PLATFORM_NAME", + "CONTENT_PLATFORM_CODE", + "AD_PLACEMENT_NAME", + "AD_PLACEMENT_CODE", + "REQUESTED_AD_TYPE_NAME", + "REQUESTED_AD_TYPE_CODE", + "SERVED_AD_TYPE_NAME", + "SERVED_AD_TYPE_CODE", + "CUSTOM_SEARCH_STYLE_NAME", + "CUSTOM_SEARCH_STYLE_ID", + "DOMAIN_REGISTRANT", + "WEBSEARCH_QUERY_STRING" + ], + "enumDescriptions": [ + "Unspecified dimension.", + "Date dimension in YYYY-MM-DD format (e.g. \"2010-02-10\").", + "Week dimension in YYYY-MM-DD format, representing the first day of each week (e.g. \"2010-02-08\"). The first day of the week is determined by the language_code specified in a report generation request (so e.g. this would be a Monday for \"en-GB\" or \"es\", but a Sunday for \"en\" or \"fr-CA\").", + "Month dimension in YYYY-MM format (e.g. \"2010-02\").", + "Account name. The members of this dimension match the values from Account.display_name.", + "Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id.", + "Localized product name (e.g. \"AdSense for Content\", \"AdSense for Search\").", + "Product code (e.g. \"AFC\", \"AFS\"). The members of this dimension match the values from AdClient.product_code.", + "Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name.", + "Unique ID of an ad unit (within which an ad was served). The members of this dimension match the values from AdUnit.reporting_dimension_id.", + "Localized size of an ad unit (e.g. \"728x90\", \"Responsive\").", + "The size code of an ad unit (e.g. \"728x90\", \"responsive\").", + "Custom channel name. The members of this dimension match the values from CustomChannel.display_name.", + "Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.", + "Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.", + "Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.", + "Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.", + "Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.", + "Name of an ad network that returned the winning ads for an ad request (e.g. \"Google AdWords\"). Note that unlike other \"NAME\" dimensions, the members of this dimensions are not localized.", + "Unique (opaque) ID of an ad network that returned the winning ads for an ad request.", + "Localized bid type name (e.g. \"CPC bids\", \"CPM bids\") for a served ad.", + "Type of a bid (e.g. \"cpc\", \"cpm\") for a served ad.", + "Localized creative size name (e.g. \"728x90\", \"Dynamic\") of a served ad.", + "Creative size code (e.g. \"728x90\", \"dynamic\") of a served ad.", + "Localized name of a host on which an ad was served, after IDNA decoding (e.g. \"www.google.com\", \"Web caches and other\", \"b\u00fccher.example\").", + "Name of a host on which an ad was served (e.g. \"www.google.com\", \"webcaches\", \"xn--bcher-kva.example\").", + "Localized region name of a user viewing an ad (e.g. \"United States\", \"France\").", + "CLDR region code of a user viewing an ad (e.g. \"US\", \"FR\").", + "Localized platform type name (e.g. \"High-end mobile devices\", \"Desktop\").", + "Platform type code (e.g. \"HighEndMobile\", \"Desktop\").", + "Localized targeting type name (e.g. \"Contextual\", \"Personalized\", \"Run of Network\").", + "Targeting type code (e.g. \"Keyword\", \"UserInterest\", \"RunOfNetwork\").", + "Localized content platform name an ad request was made from (e.g. \"AMP\", \"Web\").", + "Content platform code an ad request was made from (e.g. \"AMP\", \"HTML\").", + "Localized ad placement name (e.g. \"Ad unit\", \"Global settings\", \"Manual\").", + "Ad placement code (e.g. \"AD_UNIT\", \"ca-pub-123456:78910\", \"OTHER\").", + "Localized requested ad type name (e.g. \"Display\", \"Link unit\", \"Other\").", + "Requested ad type code (e.g. \"IMAGE\", \"RADLINK\", \"OTHER\").", + "Localized served ad type name (e.g. \"Display\", \"Link unit\", \"Other\").", + "Served ad type code (e.g. \"IMAGE\", \"RADLINK\", \"OTHER\").", + "Custom search style name.", + "Custom search style id.", + "Domain registrants.", + "Query strings for web searches." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "endDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "filters": { + "description": "Filters to be run on the report.", + "location": "query", + "repeated": true, + "type": "string" + }, + "languageCode": { + "description": "The language to use for translating report output. If unspecified, this defaults to English (\"en\"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).", + "location": "query", + "type": "string" + }, + "limit": { + "description": "The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "metrics": { + "description": "Required. Reporting metrics.", + "enum": [ + "METRIC_UNSPECIFIED", + "PAGE_VIEWS", + "AD_REQUESTS", + "MATCHED_AD_REQUESTS", + "TOTAL_IMPRESSIONS", + "IMPRESSIONS", + "INDIVIDUAL_AD_IMPRESSIONS", + "CLICKS", + "PAGE_VIEWS_SPAM_RATIO", + "AD_REQUESTS_SPAM_RATIO", + "MATCHED_AD_REQUESTS_SPAM_RATIO", + "IMPRESSIONS_SPAM_RATIO", + "INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO", + "CLICKS_SPAM_RATIO", + "AD_REQUESTS_COVERAGE", + "PAGE_VIEWS_CTR", + "AD_REQUESTS_CTR", + "MATCHED_AD_REQUESTS_CTR", + "IMPRESSIONS_CTR", + "INDIVIDUAL_AD_IMPRESSIONS_CTR", + "ACTIVE_VIEW_MEASURABILITY", + "ACTIVE_VIEW_VIEWABILITY", + "ACTIVE_VIEW_TIME", + "ESTIMATED_EARNINGS", + "PAGE_VIEWS_RPM", + "AD_REQUESTS_RPM", + "MATCHED_AD_REQUESTS_RPM", + "IMPRESSIONS_RPM", + "INDIVIDUAL_AD_IMPRESSIONS_RPM", + "COST_PER_CLICK", + "ADS_PER_IMPRESSION", + "TOTAL_EARNINGS", + "WEBSEARCH_RESULT_PAGES" + ], + "enumDescriptions": [ + "Unspecified metric.", + "Number of page views.", + "Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available.", + "Requests that returned at least one ad.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user\u2019s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user\u2019s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads.", + "Number of times a user clicked on a standard content ad.", + "Fraction of page views considered to be spam. Only available to premium accounts.", + "Fraction of ad requests considered to be spam. Only available to premium accounts.", + "Fraction of ad requests that returned ads considered to be spam. Only available to premium accounts.", + "Fraction of impressions considered to be spam. Only available to premium accounts.", + "Fraction of ad impressions considered to be spam. Only available to premium accounts.", + "Fraction of clicks considered to be spam. Only available to premium accounts.", + "Ratio of requested ad units or queries to the number returned to the site.", + "Ratio of individual page views that resulted in a click.", + "Ratio of ad requests that resulted in a click.", + "Ratio of clicks to matched requests.", + "Ratio of IMPRESSIONS that resulted in a click.", + "Ratio of individual ad impressions that resulted in a click.", + "Ratio of requests that were measurable for viewability.", + "Ratio of requests that were viewable.", + "Mean time an ad was displayed on screen.", + "Estimated earnings of the publisher. Note that earnings up to yesterday are accurate, more recent earnings are estimated due to the possibility of spam, or exchange rate fluctuations.", + "Revenue per thousand page views. This is calculated by dividing the estimated revenue by the number of page views multiplied by 1000.", + "Revenue per thousand ad requests. This is calculated by dividing estimated revenue by the number of ad requests multiplied by 1000.", + "Revenue per thousand matched ad requests. This is calculated by dividing estimated revenue by the number of matched ad requests multiplied by 1000.", + "Revenue per thousand ad impressions. This is calculated by dividing estimated revenue by the number of ad impressions multiplied by 1000.", + "Revenue per thousand individual ad impressions. This is calculated by dividing estimated revenue by the number of individual ad impressions multiplied by 1000.", + "Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.", + "Number of ad views per impression.", + "Total earnings.", + "Number of results pages." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "orderBy": { + "description": "The name of a dimension or metric to sort the resulting report on, can be prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted ascending.", + "location": "query", + "repeated": true, + "type": "string" + }, + "reportingTimeZone": { + "description": "Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).", + "enum": [ + "REPORTING_TIME_ZONE_UNSPECIFIED", + "ACCOUNT_TIME_ZONE", + "GOOGLE_TIME_ZONE" + ], + "enumDescriptions": [ + "Unspecified timezone.", + "Use the account timezone in the report.", + "Use the Google timezone in the report (America/Los_Angeles)." + ], + "location": "query", + "type": "string" + }, + "startDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v2/{+account}/reports:generateCsv", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + }, + "resources": { + "saved": { + "methods": { + "generate": { + "description": "Generates a saved report.", + "flatPath": "v2/accounts/{accountsId}/reports/{reportsId}/saved:generate", + "httpMethod": "GET", + "id": "adsense.accounts.reports.saved.generate", + "parameterOrder": [ + "name" + ], + "parameters": { + "currencyCode": { + "description": "The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.", + "location": "query", + "type": "string" + }, + "dateRange": { + "description": "Date range of the report, if unset the range will be considered CUSTOM.", + "enum": [ + "REPORTING_DATE_RANGE_UNSPECIFIED", + "CUSTOM", + "TODAY", + "YESTERDAY", + "MONTH_TO_DATE", + "YEAR_TO_DATE", + "LAST_7_DAYS", + "LAST_30_DAYS" + ], + "enumDescriptions": [ + "Unspecified date range.", + "A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.", + "Current day.", + "Yesterday.", + "From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].", + "From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].", + "Last 7 days, excluding current day.", + "Last 30 days, excluding current day." + ], + "location": "query", + "type": "string" + }, + "endDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "languageCode": { + "description": "The language to use for translating report output. If unspecified, this defaults to English (\"en\"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the saved report. Format: accounts/{account}/reports/{report}", + "location": "path", + "pattern": "^accounts/[^/]+/reports/[^/]+$", + "required": true, + "type": "string" + }, + "reportingTimeZone": { + "description": "Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).", + "enum": [ + "REPORTING_TIME_ZONE_UNSPECIFIED", + "ACCOUNT_TIME_ZONE", + "GOOGLE_TIME_ZONE" + ], + "enumDescriptions": [ + "Unspecified timezone.", + "Use the account timezone in the report.", + "Use the Google timezone in the report (America/Los_Angeles)." + ], + "location": "query", + "type": "string" + }, + "startDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v2/{+name}/saved:generate", + "response": { + "$ref": "ReportResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "generateCsv": { + "description": "Generates a csv formatted saved report.", + "flatPath": "v2/accounts/{accountsId}/reports/{reportsId}/saved:generateCsv", + "httpMethod": "GET", + "id": "adsense.accounts.reports.saved.generateCsv", + "parameterOrder": [ + "name" + ], + "parameters": { + "currencyCode": { + "description": "The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.", + "location": "query", + "type": "string" + }, + "dateRange": { + "description": "Date range of the report, if unset the range will be considered CUSTOM.", + "enum": [ + "REPORTING_DATE_RANGE_UNSPECIFIED", + "CUSTOM", + "TODAY", + "YESTERDAY", + "MONTH_TO_DATE", + "YEAR_TO_DATE", + "LAST_7_DAYS", + "LAST_30_DAYS" + ], + "enumDescriptions": [ + "Unspecified date range.", + "A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.", + "Current day.", + "Yesterday.", + "From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].", + "From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].", + "Last 7 days, excluding current day.", + "Last 30 days, excluding current day." + ], + "location": "query", + "type": "string" + }, + "endDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "languageCode": { + "description": "The language to use for translating report output. If unspecified, this defaults to English (\"en\"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the saved report. Format: accounts/{account}/reports/{report}", + "location": "path", + "pattern": "^accounts/[^/]+/reports/[^/]+$", + "required": true, + "type": "string" + }, + "reportingTimeZone": { + "description": "Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).", + "enum": [ + "REPORTING_TIME_ZONE_UNSPECIFIED", + "ACCOUNT_TIME_ZONE", + "GOOGLE_TIME_ZONE" + ], + "enumDescriptions": [ + "Unspecified timezone.", + "Use the account timezone in the report.", + "Use the Google timezone in the report (America/Los_Angeles)." + ], + "location": "query", + "type": "string" + }, + "startDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v2/{+name}/saved:generateCsv", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists saved reports.", + "flatPath": "v2/accounts/{accountsId}/reports/saved", + "httpMethod": "GET", + "id": "adsense.accounts.reports.saved.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListPayments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPayments` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account which owns the collection of reports. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/reports/saved", + "response": { + "$ref": "ListSavedReportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + } + } + } + }, + "sites": { + "methods": { + "get": { + "description": "Gets information about the selected site.", + "flatPath": "v2/accounts/{accountsId}/sites/{sitesId}", + "httpMethod": "GET", + "id": "adsense.accounts.sites.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the site. Format: accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists all the sites available in an account.", + "flatPath": "v2/accounts/{accountsId}/sites", + "httpMethod": "GET", + "id": "adsense.accounts.sites.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account which owns the collection of sites. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + } + } + } + } + }, + "revision": "20210426", + "rootUrl": "https://adsense.googleapis.com/", + "schemas": { + "Account": { + "description": "Representation of an account.", + "id": "Account", + "properties": { + "createTime": { + "description": "Output only. Creation time of the account.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. Display name of this account.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name of the account. Format: accounts/pub-[0-9]+", + "type": "string" + }, + "pendingTasks": { + "description": "Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. \"billing-profile-creation\", \"phone-pin-verification\".", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "premium": { + "description": "Output only. Whether this account is premium.", + "readOnly": true, + "type": "boolean" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725)." + } + }, + "type": "object" + }, + "AdClient": { + "description": "Representation of an ad client. An ad client represents a user's subscription with a specific AdSense product.", + "id": "AdClient", + "properties": { + "name": { + "description": "Resource name of the ad client. Format: accounts/{account}/adclient/{adclient}", + "type": "string" + }, + "productCode": { + "description": "Output only. Product code of the ad client. For example, \"AFC\" for AdSense for Content.", + "readOnly": true, + "type": "string" + }, + "reportingDimensionId": { + "description": "Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AdClientAdCode": { + "description": "Representation of the AdSense code for a given ad client. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).", + "id": "AdClientAdCode", + "properties": { + "adCode": { + "description": "Output only. The AdSense code snippet to add to the head of an HTML page.", + "readOnly": true, + "type": "string" + }, + "ampBody": { + "description": "Output only. The AdSense code snippet to add to the body of an AMP page.", + "readOnly": true, + "type": "string" + }, + "ampHead": { + "description": "Output only. The AdSense code snippet to add to the head of an AMP page.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AdUnit": { + "description": "Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.", + "id": "AdUnit", + "properties": { + "contentAdsSettings": { + "$ref": "ContentAdsSettings", + "description": "Settings specific to content ads (AFC)." + }, + "displayName": { + "description": "Display name of the ad unit, as provided when the ad unit was created.", + "type": "string" + }, + "name": { + "description": "Resource name of the ad unit. Format: accounts/{account}/adclient/{adclient}/adunits/{adunit}", + "type": "string" + }, + "reportingDimensionId": { + "description": "Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "State of the ad unit.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "ARCHIVED" + ], + "enumDescriptions": [ + "State unspecified.", + "Ad unit has been activated by the user and can serve ads.", + "Ad unit has been archived by the user and can no longer serve ads." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdUnitAdCode": { + "description": "Representation of the AdSense code for a given ad unit.", + "id": "AdUnitAdCode", + "properties": { + "adCode": { + "description": "Output only. The AdSense code snippet to add to the body of an HTML page.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Alert": { + "description": "Representation of an alert.", + "id": "Alert", + "properties": { + "message": { + "description": "Output only. The localized alert message. This may contain HTML markup, such as phrase elements or links.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name of the alert. Format: accounts/{account}/alerts/{alert}", + "type": "string" + }, + "severity": { + "description": "Output only. Severity of this alert.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "INFO", + "WARNING", + "SEVERE" + ], + "enumDescriptions": [ + "Unspecified severity.", + "Info.", + "Warning.", + "Severe." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. Type of alert. This identifies the broad type of this alert, and provides a stable machine-readable identifier that will not be translated. For example, \"payment-hold\".", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Cell": { + "description": "Cell representation.", + "id": "Cell", + "properties": { + "value": { + "description": "Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.", + "type": "string" + } + }, + "type": "object" + }, + "ContentAdsSettings": { + "description": "Settings specific to content ads (AFC).", + "id": "ContentAdsSettings", + "properties": { + "size": { + "description": "Size of the ad unit. e.g. \"728x90\", \"1x3\" (for responsive ad units).", + "type": "string" + }, + "type": { + "description": "Type of the ad unit.", + "enum": [ + "TYPE_UNSPECIFIED", + "DISPLAY", + "FEED", + "ARTICLE", + "MATCHED_CONTENT", + "LINK" + ], + "enumDescriptions": [ + "Unspecified ad unit type.", + "Display ad unit.", + "In-feed ad unit.", + "In-article ad unit.", + "Matched content unit.", + "Link ad unit. Note that link ad units are being retired, see https://support.google.com/adsense/answer/9987221." + ], + "type": "string" + } + }, + "type": "object" + }, + "CustomChannel": { + "description": "Representation of a custom channel.", + "id": "CustomChannel", + "properties": { + "displayName": { + "description": "Display name of the custom channel.", + "type": "string" + }, + "name": { + "description": "Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}", + "type": "string" + }, + "reportingDimensionId": { + "description": "Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Header": { + "description": "The header information of the columns requested in the report.", + "id": "Header", + "properties": { + "currencyCode": { + "description": "The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY.", + "type": "string" + }, + "name": { + "description": "Required. Name of the header.", + "type": "string" + }, + "type": { + "description": "Required. Type of the header.", + "enum": [ + "HEADER_TYPE_UNSPECIFIED", + "DIMENSION", + "METRIC_TALLY", + "METRIC_RATIO", + "METRIC_CURRENCY", + "METRIC_MILLISECONDS", + "METRIC_DECIMAL" + ], + "enumDescriptions": [ + "Unspecified header.", + "Dimension header type.", + "Tally header type.", + "Ratio header type.", + "Currency header type.", + "Milliseconds header type.", + "Decimal header type." + ], + "type": "string" + } + }, + "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" + }, + "ListAccountsResponse": { + "description": "Response definition for the account list rpc.", + "id": "ListAccountsResponse", + "properties": { + "accounts": { + "description": "The accounts returned in this list response.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdClientsResponse": { + "description": "Response definition for the ad client list rpc.", + "id": "ListAdClientsResponse", + "properties": { + "adClients": { + "description": "The ad clients returned in this list response.", + "items": { + "$ref": "AdClient" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdUnitsResponse": { + "description": "Response definition for the adunit list rpc.", + "id": "ListAdUnitsResponse", + "properties": { + "adUnits": { + "description": "The ad units returned in the list response.", + "items": { + "$ref": "AdUnit" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListAlertsResponse": { + "description": "Response definition for the alerts list rpc.", + "id": "ListAlertsResponse", + "properties": { + "alerts": { + "description": "The alerts returned in this list response.", + "items": { + "$ref": "Alert" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListChildAccountsResponse": { + "description": "Response definition for the child account list rpc.", + "id": "ListChildAccountsResponse", + "properties": { + "accounts": { + "description": "The accounts returned in this list response.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomChannelsResponse": { + "description": "Response definition for the custom channel list rpc.", + "id": "ListCustomChannelsResponse", + "properties": { + "customChannels": { + "description": "The custom channels returned in this list response.", + "items": { + "$ref": "CustomChannel" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListLinkedAdUnitsResponse": { + "description": "Response definition for the ad units linked to a custom channel list rpc.", + "id": "ListLinkedAdUnitsResponse", + "properties": { + "adUnits": { + "description": "The ad units returned in the list response.", + "items": { + "$ref": "AdUnit" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListLinkedCustomChannelsResponse": { + "description": "Response definition for the custom channels linked to an adunit list rpc.", + "id": "ListLinkedCustomChannelsResponse", + "properties": { + "customChannels": { + "description": "The custom channels returned in this list response.", + "items": { + "$ref": "CustomChannel" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListPaymentsResponse": { + "description": "Response definition for the payments list rpc.", + "id": "ListPaymentsResponse", + "properties": { + "payments": { + "description": "The payments returned in this list response.", + "items": { + "$ref": "Payment" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSavedReportsResponse": { + "description": "Response definition for the saved reports list rpc.", + "id": "ListSavedReportsResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token used to page through reports. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + }, + "savedReports": { + "description": "The reports returned in this list response.", + "items": { + "$ref": "SavedReport" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSitesResponse": { + "description": "Response definition for the sites list rpc.", + "id": "ListSitesResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + }, + "sites": { + "description": "The sites returned in this list response.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListUrlChannelsResponse": { + "description": "Response definition for the url channels list rpc.", + "id": "ListUrlChannelsResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token used to page through url channels. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + }, + "urlChannels": { + "description": "The url channels returned in this list response.", + "items": { + "$ref": "UrlChannel" + }, + "type": "array" + } + }, + "type": "object" + }, + "Payment": { + "description": "Representation of an unpaid or paid payment. See [Payment timelines for AdSense](https://support.google.com/adsense/answer/7164703) for more information about payments.", + "id": "Payment", + "properties": { + "amount": { + "description": "Output only. The amount of unpaid or paid earnings, as a formatted string, including the currency. E.g. \"\u00a51,235 JPY\", \"$1,234.57\", \"\u00a387.65\".", + "readOnly": true, + "type": "string" + }, + "date": { + "$ref": "Date", + "description": "Output only. For paid earnings, the date that the payment was credited. For unpaid earnings, this field is empty. Payment dates are always returned in the billing timezone (America/Los_Angeles).", + "readOnly": true + }, + "name": { + "description": "Resource name of the payment. Format: accounts/{account}/payments/unpaid for unpaid (current) earnings. accounts/{account}/payments/yyyy-MM-dd for paid earnings.", + "type": "string" + } + }, + "type": "object" + }, + "ReportResult": { + "description": "Result of a generated report.", + "id": "ReportResult", + "properties": { + "averages": { + "$ref": "Row", + "description": "The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty." + }, + "endDate": { + "$ref": "Date", + "description": "Required. End date of the range (inclusive)." + }, + "headers": { + "description": "The header information; one for each dimension in the request, followed by one for each metric in the request.", + "items": { + "$ref": "Header" + }, + "type": "array" + }, + "rows": { + "description": "The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request.", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "startDate": { + "$ref": "Date", + "description": "Required. Start date of the range (inclusive)." + }, + "totalMatchedRows": { + "description": "The total number of rows matched by the report request.", + "format": "int64", + "type": "string" + }, + "totals": { + "$ref": "Row", + "description": "The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty." + }, + "warnings": { + "description": "Any warnings associated with generation of the report. These warnings are always returned in English.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Row": { + "description": "Row representation.", + "id": "Row", + "properties": { + "cells": { + "description": "Cells in the row.", + "items": { + "$ref": "Cell" + }, + "type": "array" + } + }, + "type": "object" + }, + "SavedReport": { + "description": "Representation of a saved report.", + "id": "SavedReport", + "properties": { + "name": { + "description": "Resource name of the report. Format: accounts/{account}/reports/{report}", + "type": "string" + }, + "title": { + "description": "Report title as specified by publisher.", + "type": "string" + } + }, + "type": "object" + }, + "Site": { + "description": "Representation of a Site.", + "id": "Site", + "properties": { + "autoAdsEnabled": { + "description": "Whether auto ads is turned on for the site.", + "type": "boolean" + }, + "domain": { + "description": "Domain (or subdomain) of the site, e.g. \"example.com\" or \"www.example.com\". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension.", + "type": "string" + }, + "name": { + "description": "Resource name of a site. Format: accounts/{account}/sites/{site}", + "type": "string" + }, + "reportingDimensionId": { + "description": "Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of a site.", + "enum": [ + "STATE_UNSPECIFIED", + "REQUIRES_REVIEW", + "GETTING_READY", + "READY", + "NEEDS_ATTENTION" + ], + "enumDescriptions": [ + "State unspecified.", + "The site hasn't been checked yet.", + "Running some checks on the site. This usually takes a few days, but in some cases can take up to 2 weeks.", + "The site is ready to show ads.", + "Publisher needs to fix some issues before the site is ready to show ads." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "type": "string" + } + }, + "type": "object" + }, + "UrlChannel": { + "description": "Representation of a URL channel. URL channels allow you to track the performance of particular pages in your site; see [URL channels](https://support.google.com/adsense/answer/2923836) for more information.", + "id": "UrlChannel", + "properties": { + "name": { + "description": "Resource name of the URL channel. Format: accounts/{account}/adclient/{adclient}/urlchannels/{urlchannel}", + "type": "string" + }, + "reportingDimensionId": { + "description": "Output only. Unique ID of the custom channel as used in the `URL_CHANNEL_ID` reporting dimension.", + "readOnly": true, + "type": "string" + }, + "uriPattern": { + "description": "URI pattern of the channel. Does not include \"http://\" or \"https://\". Example: www.example.com/home", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "AdSense Management API", + "version": "v2", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index aa6bd1a9afb..a08c3f643ca 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -116,10 +116,10 @@ "parameters": {}, "path": "v1beta1/alerts:batchDelete", "request": { - "$ref": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsRequest" + "$ref": "BatchDeleteAlertsRequest" }, "response": { - "$ref": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsResponse" + "$ref": "BatchDeleteAlertsResponse" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -134,10 +134,10 @@ "parameters": {}, "path": "v1beta1/alerts:batchUndelete", "request": { - "$ref": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsRequest" + "$ref": "BatchUndeleteAlertsRequest" }, "response": { - "$ref": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsResponse" + "$ref": "BatchUndeleteAlertsResponse" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -166,7 +166,7 @@ }, "path": "v1beta1/alerts/{alertId}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -195,7 +195,7 @@ }, "path": "v1beta1/alerts/{alertId}", "response": { - "$ref": "GoogleAppsAlertcenterV1beta1Alert" + "$ref": "Alert" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -224,7 +224,7 @@ }, "path": "v1beta1/alerts/{alertId}/metadata", "response": { - "$ref": "GoogleAppsAlertcenterV1beta1AlertMetadata" + "$ref": "AlertMetadata" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -266,7 +266,7 @@ }, "path": "v1beta1/alerts", "response": { - "$ref": "GoogleAppsAlertcenterV1beta1ListAlertsResponse" + "$ref": "ListAlertsResponse" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -290,10 +290,10 @@ }, "path": "v1beta1/alerts/{alertId}:undelete", "request": { - "$ref": "GoogleAppsAlertcenterV1beta1UndeleteAlertRequest" + "$ref": "UndeleteAlertRequest" }, "response": { - "$ref": "GoogleAppsAlertcenterV1beta1Alert" + "$ref": "Alert" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -326,10 +326,10 @@ }, "path": "v1beta1/alerts/{alertId}/feedback", "request": { - "$ref": "GoogleAppsAlertcenterV1beta1AlertFeedback" + "$ref": "AlertFeedback" }, "response": { - "$ref": "GoogleAppsAlertcenterV1beta1AlertFeedback" + "$ref": "AlertFeedback" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -363,7 +363,7 @@ }, "path": "v1beta1/alerts/{alertId}/feedback", "response": { - "$ref": "GoogleAppsAlertcenterV1beta1ListAlertFeedbackResponse" + "$ref": "ListAlertFeedbackResponse" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -390,7 +390,7 @@ }, "path": "v1beta1/settings", "response": { - "$ref": "GoogleAppsAlertcenterV1beta1Settings" + "$ref": "Settings" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -411,10 +411,10 @@ }, "path": "v1beta1/settings", "request": { - "$ref": "GoogleAppsAlertcenterV1beta1Settings" + "$ref": "Settings" }, "response": { - "$ref": "GoogleAppsAlertcenterV1beta1Settings" + "$ref": "Settings" }, "scopes": [ "https://www.googleapis.com/auth/apps.alerts" @@ -423,43 +423,33 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { - "GoogleAppsAlertcenterTypeAccountWarning": { + "AccountWarning": { "description": "Alerts for user account warning events.", - "id": "GoogleAppsAlertcenterTypeAccountWarning", + "id": "AccountWarning", "properties": { "email": { "description": "Required. The email of the user that this event belongs to.", "type": "string" }, "loginDetails": { - "$ref": "GoogleAppsAlertcenterTypeAccountWarningLoginDetails", + "$ref": "LoginDetails", "description": "Optional. Details of the login action associated with the warning event. This is only available for: * Suspicious login * Suspicious login (less secure app) * Suspicious programmatic login * User suspended (suspicious activity)" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeAccountWarningLoginDetails": { - "description": "The details of the login action.", - "id": "GoogleAppsAlertcenterTypeAccountWarningLoginDetails", - "properties": { - "ipAddress": { - "description": "Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event.", - "type": "string" - }, - "loginTime": { - "description": "Optional. The successful login time that is associated with the warning event. This isn't present for blocked login attempts.", - "format": "google-datetime", - "type": "string" - } - }, + "ActionInfo": { + "description": "Metadata related to the action.", + "id": "ActionInfo", + "properties": {}, "type": "object" }, - "GoogleAppsAlertcenterTypeActivityRule": { + "ActivityRule": { "description": "Alerts from Google Workspace Security Center rules service configured by an admin.", - "id": "GoogleAppsAlertcenterTypeActivityRule", + "id": "ActivityRule", "properties": { "actionNames": { "description": "List of action names associated with the rule threshold.", @@ -521,105 +511,194 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotification": { - "description": "Alerts from App Maker to notify admins to set up default SQL instance.", - "id": "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotification", + "Alert": { + "description": "An alert affecting a customer.", + "id": "Alert", "properties": { - "requestInfo": { - "description": "List of applications with requests for default SQL set up.", - "items": { - "$ref": "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotificationRequestInfo" + "alertId": { + "description": "Output only. The unique identifier for the alert.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time this alert was created.", + "format": "google-datetime", + "type": "string" + }, + "customerId": { + "description": "Output only. The unique identifier of the Google account of the customer.", + "type": "string" + }, + "data": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" }, - "type": "array" + "description": "Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.", + "type": "object" + }, + "deleted": { + "description": "Output only. `True` if this alert is marked for deletion.", + "type": "boolean" + }, + "endTime": { + "description": "Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.", + "format": "google-datetime", + "type": "string" + }, + "etag": { + "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.", + "type": "string" + }, + "metadata": { + "$ref": "AlertMetadata", + "description": "Output only. The metadata associated with this alert." + }, + "securityInvestigationToolLink": { + "description": "Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.", + "type": "string" + }, + "source": { + "description": "Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity", + "type": "string" + }, + "startTime": { + "description": "Required. The time the event that caused this alert was started or detected.", + "format": "google-datetime", + "type": "string" + }, + "type": { + "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](/admin-sdk/alertcenter/reference/alert-types).", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time this alert was last updated.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotificationRequestInfo": { - "description": "Requests for one application that needs default SQL setup.", - "id": "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotificationRequestInfo", + "AlertFeedback": { + "description": "A customer feedback about an alert.", + "id": "AlertFeedback", "properties": { - "appDeveloperEmail": { - "description": "List of app developers who triggered notifications for above application.", - "items": { - "type": "string" - }, - "type": "array" + "alertId": { + "description": "Output only. The alert identifier.", + "type": "string" }, - "appKey": { - "description": "Required. The application that requires the SQL setup.", + "createTime": { + "description": "Output only. The time this feedback was created.", + "format": "google-datetime", "type": "string" }, - "numberOfRequests": { - "description": "Required. Number of requests sent for this application to set up default SQL instance.", - "format": "int64", + "customerId": { + "description": "Output only. The unique identifier of the Google account of the customer.", + "type": "string" + }, + "email": { + "description": "Output only. The email of the user that provided the feedback.", + "type": "string" + }, + "feedbackId": { + "description": "Output only. The unique identifier for the feedback.", + "type": "string" + }, + "type": { + "description": "Required. The type of the feedback.", + "enum": [ + "ALERT_FEEDBACK_TYPE_UNSPECIFIED", + "NOT_USEFUL", + "SOMEWHAT_USEFUL", + "VERY_USEFUL" + ], + "enumDescriptions": [ + "The feedback type is not specified.", + "The alert report is not useful.", + "The alert report is somewhat useful.", + "The alert report is very useful." + ], "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeAttachment": { - "description": "Attachment with application-specific information about an alert.", - "id": "GoogleAppsAlertcenterTypeAttachment", + "AlertMetadata": { + "description": "An alert metadata.", + "id": "AlertMetadata", "properties": { - "csv": { - "$ref": "GoogleAppsAlertcenterTypeAttachmentCsv", - "description": "A CSV file attachment." + "alertId": { + "description": "Output only. The alert identifier.", + "type": "string" + }, + "assignee": { + "description": "The email address of the user assigned to the alert.", + "type": "string" + }, + "customerId": { + "description": "Output only. The unique identifier of the Google account of the customer.", + "type": "string" + }, + "etag": { + "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.", + "type": "string" + }, + "severity": { + "description": "The severity value of the alert. Alert Center will set this field at alert creation time, default's to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW", + "type": "string" + }, + "status": { + "description": "The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time this metadata was last updated.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeAttachmentCsv": { - "description": "A representation of a CSV file attachment, as a list of column headers and a list of data rows.", - "id": "GoogleAppsAlertcenterTypeAttachmentCsv", + "AppMakerSqlSetupNotification": { + "description": "Alerts from App Maker to notify admins to set up default SQL instance.", + "id": "AppMakerSqlSetupNotification", "properties": { - "dataRows": { - "description": "The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.", - "items": { - "$ref": "GoogleAppsAlertcenterTypeAttachmentCsvCsvRow" - }, - "type": "array" - }, - "headers": { - "description": "The list of headers for data columns in a CSV file.", + "requestInfo": { + "description": "List of applications with requests for default SQL set up.", "items": { - "type": "string" + "$ref": "RequestInfo" }, "type": "array" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeAttachmentCsvCsvRow": { - "description": "A representation of a single data row in a CSV file.", - "id": "GoogleAppsAlertcenterTypeAttachmentCsvCsvRow", + "Attachment": { + "description": "Attachment with application-specific information about an alert.", + "id": "Attachment", "properties": { - "entries": { - "description": "The data entries in a CSV file row, as a string array rather than a single comma-separated string.", - "items": { - "type": "string" - }, - "type": "array" + "csv": { + "$ref": "Csv", + "description": "A CSV file attachment." } }, "type": "object" }, - "GoogleAppsAlertcenterTypeBadWhitelist": { + "BadWhitelist": { "description": "Alert for setting the domain or IP that malicious email comes from as whitelisted domain or IP in Gmail advanced settings.", - "id": "GoogleAppsAlertcenterTypeBadWhitelist", + "id": "BadWhitelist", "properties": { "domainId": { - "$ref": "GoogleAppsAlertcenterTypeDomainId", + "$ref": "DomainId", "description": "The domain ID." }, "maliciousEntity": { - "$ref": "GoogleAppsAlertcenterTypeMaliciousEntity", + "$ref": "MaliciousEntity", "description": "The entity whose actions triggered a Gmail phishing alert." }, "messages": { "description": "The list of messages contained by this alert.", "items": { - "$ref": "GoogleAppsAlertcenterTypeGmailMessageInfo" + "$ref": "GmailMessageInfo" }, "type": "array" }, @@ -630,89 +709,225 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeDeviceCompromised": { - "description": "A mobile device compromised alert. Derived from audit logs.", - "id": "GoogleAppsAlertcenterTypeDeviceCompromised", + "BatchDeleteAlertsRequest": { + "description": "A request to perform batch delete on alerts.", + "id": "BatchDeleteAlertsRequest", "properties": { - "email": { - "description": "The email of the user this alert was created for.", - "type": "string" - }, - "events": { - "description": "Required. The list of security events.", + "alertId": { + "description": "Required. list of alert IDs.", "items": { - "$ref": "GoogleAppsAlertcenterTypeDeviceCompromisedDeviceCompromisedSecurityDetail" + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterTypeDeviceCompromisedDeviceCompromisedSecurityDetail": { - "description": "Detailed information of a single MDM device compromised event.", - "id": "GoogleAppsAlertcenterTypeDeviceCompromisedDeviceCompromisedSecurityDetail", - "properties": { - "deviceCompromisedState": { - "description": "The device compromised state. Possible values are \"`Compromised`\" or \"`Not Compromised`\".", - "type": "string" - }, - "deviceId": { - "description": "Required. The device ID.", - "type": "string" - }, - "deviceModel": { - "description": "The model of the device.", - "type": "string" - }, - "deviceType": { - "description": "The type of the device.", - "type": "string" - }, - "iosVendorId": { - "description": "Required for iOS, empty for others.", - "type": "string" - }, - "resourceId": { - "description": "The device resource ID.", - "type": "string" }, - "serialNumber": { - "description": "The serial number of the device.", + "customerId": { + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.", "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeDlpRuleViolation": { - "description": "Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.", - "id": "GoogleAppsAlertcenterTypeDlpRuleViolation", + "BatchDeleteAlertsResponse": { + "description": "Response to batch delete operation on alerts.", + "id": "BatchDeleteAlertsResponse", "properties": { - "ruleViolationInfo": { - "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfo", - "description": "Details about the violated DLP rule. Admins can use the predefined detectors provided by Google Cloud DLP https://cloud.google.com/dlp/ when setting up a DLP rule. Matched Cloud DLP detectors in this violation if any will be captured in the MatchInfo.predefined_detector." + "failedAlertStatus": { + "additionalProperties": { + "$ref": "Status" + }, + "description": "The status details for each failed alert_id.", + "type": "object" + }, + "successAlertIds": { + "description": "The successful list of alert IDs.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeDomainId": { - "description": "Domain ID of Gmail phishing alerts.", - "id": "GoogleAppsAlertcenterTypeDomainId", + "BatchUndeleteAlertsRequest": { + "description": "A request to perform batch undelete on alerts.", + "id": "BatchUndeleteAlertsRequest", "properties": { - "customerPrimaryDomain": { - "description": "The primary domain for the customer.", + "alertId": { + "description": "Required. list of alert IDs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "customerId": { + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.", "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeDomainWideTakeoutInitiated": { - "description": "A takeout operation for the entire domain was initiated by an admin. Derived from audit logs.", - "id": "GoogleAppsAlertcenterTypeDomainWideTakeoutInitiated", + "BatchUndeleteAlertsResponse": { + "description": "Response to batch undelete operation on alerts.", + "id": "BatchUndeleteAlertsResponse", "properties": { - "email": { - "description": "The email of the admin who initiated the takeout.", - "type": "string" - }, + "failedAlertStatus": { + "additionalProperties": { + "$ref": "Status" + }, + "description": "The status details for each failed alert_id.", + "type": "object" + }, + "successAlertIds": { + "description": "The successful list of alert IDs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudPubsubTopic": { + "description": "A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.", + "id": "CloudPubsubTopic", + "properties": { + "payloadFormat": { + "description": "Optional. The format of the payload that would be sent. If not specified the format will be JSON.", + "enum": [ + "PAYLOAD_FORMAT_UNSPECIFIED", + "JSON" + ], + "enumDescriptions": [ + "Payload format is not specified (will use JSON as default).", + "Use JSON." + ], + "type": "string" + }, + "topicName": { + "description": "The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).", + "type": "string" + } + }, + "type": "object" + }, + "Csv": { + "description": "A representation of a CSV file attachment, as a list of column headers and a list of data rows.", + "id": "Csv", + "properties": { + "dataRows": { + "description": "The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.", + "items": { + "$ref": "CsvRow" + }, + "type": "array" + }, + "headers": { + "description": "The list of headers for data columns in a CSV file.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CsvRow": { + "description": "A representation of a single data row in a CSV file.", + "id": "CsvRow", + "properties": { + "entries": { + "description": "The data entries in a CSV file row, as a string array rather than a single comma-separated string.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DeviceCompromised": { + "description": "A mobile device compromised alert. Derived from audit logs.", + "id": "DeviceCompromised", + "properties": { + "email": { + "description": "The email of the user this alert was created for.", + "type": "string" + }, + "events": { + "description": "Required. The list of security events.", + "items": { + "$ref": "DeviceCompromisedSecurityDetail" + }, + "type": "array" + } + }, + "type": "object" + }, + "DeviceCompromisedSecurityDetail": { + "description": "Detailed information of a single MDM device compromised event.", + "id": "DeviceCompromisedSecurityDetail", + "properties": { + "deviceCompromisedState": { + "description": "The device compromised state. Possible values are \"`Compromised`\" or \"`Not Compromised`\".", + "type": "string" + }, + "deviceId": { + "description": "Required. The device ID.", + "type": "string" + }, + "deviceModel": { + "description": "The model of the device.", + "type": "string" + }, + "deviceType": { + "description": "The type of the device.", + "type": "string" + }, + "iosVendorId": { + "description": "Required for iOS, empty for others.", + "type": "string" + }, + "resourceId": { + "description": "The device resource ID.", + "type": "string" + }, + "serialNumber": { + "description": "The serial number of the device.", + "type": "string" + } + }, + "type": "object" + }, + "DlpRuleViolation": { + "description": "Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.", + "id": "DlpRuleViolation", + "properties": { + "ruleViolationInfo": { + "$ref": "RuleViolationInfo", + "description": "Details about the violated DLP rule. Admins can use the predefined detectors provided by Google Cloud DLP https://cloud.google.com/dlp/ when setting up a DLP rule. Matched Cloud DLP detectors in this violation if any will be captured in the MatchInfo.predefined_detector." + } + }, + "type": "object" + }, + "DomainId": { + "description": "Domain ID of Gmail phishing alerts.", + "id": "DomainId", + "properties": { + "customerPrimaryDomain": { + "description": "The primary domain for the customer.", + "type": "string" + } + }, + "type": "object" + }, + "DomainWideTakeoutInitiated": { + "description": "A takeout operation for the entire domain was initiated by an admin. Derived from audit logs.", + "id": "DomainWideTakeoutInitiated", + "properties": { + "email": { + "description": "The email of the admin who initiated the takeout.", + "type": "string" + }, "takeoutRequestId": { "description": "The takeout request ID.", "type": "string" @@ -720,9 +935,15 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeGmailMessageInfo": { + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "GmailMessageInfo": { "description": "Details of a message in phishing spike alert.", - "id": "GoogleAppsAlertcenterTypeGmailMessageInfo", + "id": "GmailMessageInfo", "properties": { "attachmentsSha256Hash": { "description": "The `SHA256` hash of email's attachment and all MIME parts.", @@ -763,9 +984,9 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeGoogleOperations": { + "GoogleOperations": { "description": "An incident reported by Google Operations for a Google Workspace application.", - "id": "GoogleAppsAlertcenterTypeGoogleOperations", + "id": "GoogleOperations", "properties": { "affectedUserEmails": { "description": "The list of emails which correspond to the users directly affected by the incident.", @@ -775,7 +996,7 @@ "type": "array" }, "attachmentData": { - "$ref": "GoogleAppsAlertcenterTypeAttachment", + "$ref": "Attachment", "description": "Optional. Application-specific data for an incident, provided when the Google Workspace application which reported the incident cannot be completely restored to a valid state." }, "description": { @@ -793,12 +1014,60 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeMailPhishing": { + "ListAlertFeedbackResponse": { + "description": "Response message for an alert feedback listing request.", + "id": "ListAlertFeedbackResponse", + "properties": { + "feedback": { + "description": "The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.", + "items": { + "$ref": "AlertFeedback" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListAlertsResponse": { + "description": "Response message for an alert listing request.", + "id": "ListAlertsResponse", + "properties": { + "alerts": { + "description": "The list of alerts.", + "items": { + "$ref": "Alert" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.", + "type": "string" + } + }, + "type": "object" + }, + "LoginDetails": { + "description": "The details of the login action.", + "id": "LoginDetails", + "properties": { + "ipAddress": { + "description": "Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event.", + "type": "string" + }, + "loginTime": { + "description": "Optional. The successful login time that is associated with the warning event. This isn't present for blocked login attempts.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "MailPhishing": { "description": "Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification * Gmail potential employee spoofing", - "id": "GoogleAppsAlertcenterTypeMailPhishing", + "id": "MailPhishing", "properties": { "domainId": { - "$ref": "GoogleAppsAlertcenterTypeDomainId", + "$ref": "DomainId", "description": "The domain ID." }, "isInternal": { @@ -806,13 +1075,13 @@ "type": "boolean" }, "maliciousEntity": { - "$ref": "GoogleAppsAlertcenterTypeMaliciousEntity", + "$ref": "MaliciousEntity", "description": "The entity whose actions triggered a Gmail phishing alert." }, "messages": { "description": "The list of messages contained by this alert.", "items": { - "$ref": "GoogleAppsAlertcenterTypeGmailMessageInfo" + "$ref": "GmailMessageInfo" }, "type": "array" }, @@ -833,16 +1102,16 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeMaliciousEntity": { + "MaliciousEntity": { "description": "Entity whose actions triggered a Gmail phishing alert.", - "id": "GoogleAppsAlertcenterTypeMaliciousEntity", + "id": "MaliciousEntity", "properties": { "displayName": { "description": "The header from display name.", "type": "string" }, "entity": { - "$ref": "GoogleAppsAlertcenterTypeUser", + "$ref": "User", "description": "The actor who triggered a gmail phishing alert." }, "fromHeader": { @@ -852,12 +1121,38 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypePhishingSpike": { + "MatchInfo": { + "description": "Proto that contains match information from the condition part of the rule.", + "id": "MatchInfo", + "properties": { + "predefinedDetector": { + "$ref": "PredefinedDetectorInfo", + "description": "For matched detector predefined by Google." + }, + "userDefinedDetector": { + "$ref": "UserDefinedDetectorInfo", + "description": "For matched detector defined by administrators." + } + }, + "type": "object" + }, + "Notification": { + "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](/admin-sdk/alertcenter/guides/notifications).", + "id": "Notification", + "properties": { + "cloudPubsubTopic": { + "$ref": "CloudPubsubTopic", + "description": "A Google Cloud Pub/sub topic destination." + } + }, + "type": "object" + }, + "PhishingSpike": { "description": "Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead.", - "id": "GoogleAppsAlertcenterTypePhishingSpike", + "id": "PhishingSpike", "properties": { "domainId": { - "$ref": "GoogleAppsAlertcenterTypeDomainId", + "$ref": "DomainId", "description": "The domain ID." }, "isInternal": { @@ -865,61 +1160,125 @@ "type": "boolean" }, "maliciousEntity": { - "$ref": "GoogleAppsAlertcenterTypeMaliciousEntity", + "$ref": "MaliciousEntity", "description": "The entity whose actions triggered a Gmail phishing alert." }, "messages": { "description": "The list of messages contained by this alert.", "items": { - "$ref": "GoogleAppsAlertcenterTypeGmailMessageInfo" + "$ref": "GmailMessageInfo" }, "type": "array" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeRuleViolationInfo": { - "description": "Common alert information about violated rules that are configured by Google Workspace administrators.", - "id": "GoogleAppsAlertcenterTypeRuleViolationInfo", + "PredefinedDetectorInfo": { + "description": "Detector provided by Google.", + "id": "PredefinedDetectorInfo", "properties": { - "dataSource": { - "description": "Source of the data.", - "enum": [ - "DATA_SOURCE_UNSPECIFIED", - "DRIVE" - ], - "enumDescriptions": [ - "Data source is unspecified.", - "Drive data source." - ], + "detectorName": { + "description": "Name that uniquely identifies the detector.", "type": "string" - }, - "matchInfo": { - "description": "List of matches that were found in the resource content.", - "items": { - "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfo" - }, - "type": "array" - }, - "recipients": { - "description": "Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to.", + } + }, + "type": "object" + }, + "RequestInfo": { + "description": "Requests for one application that needs default SQL setup.", + "id": "RequestInfo", + "properties": { + "appDeveloperEmail": { + "description": "List of app developers who triggered notifications for above application.", "items": { "type": "string" }, "type": "array" }, - "resourceInfo": { - "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoResourceInfo", - "description": "Details of the resource which violated the rule." + "appKey": { + "description": "Required. The application that requires the SQL setup.", + "type": "string" }, - "ruleInfo": { - "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoRuleInfo", - "description": "Details of the violated rule." + "numberOfRequests": { + "description": "Required. Number of requests sent for this application to set up default SQL instance.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ResourceInfo": { + "description": "Proto that contains resource information.", + "id": "ResourceInfo", + "properties": { + "documentId": { + "description": "Drive file ID.", + "type": "string" }, - "suppressedActionTypes": { - "description": "Actions suppressed due to other actions with higher priority.", - "items": { - "enum": [ + "resourceTitle": { + "description": "Title of the resource, for example email subject, or document title.", + "type": "string" + } + }, + "type": "object" + }, + "RuleInfo": { + "description": "Proto that contains rule information.", + "id": "RuleInfo", + "properties": { + "displayName": { + "description": "User provided name of the rule.", + "type": "string" + }, + "resourceName": { + "description": "Resource name that uniquely identifies the rule.", + "type": "string" + } + }, + "type": "object" + }, + "RuleViolationInfo": { + "description": "Common alert information about violated rules that are configured by Google Workspace administrators.", + "id": "RuleViolationInfo", + "properties": { + "dataSource": { + "description": "Source of the data.", + "enum": [ + "DATA_SOURCE_UNSPECIFIED", + "DRIVE" + ], + "enumDescriptions": [ + "Data source is unspecified.", + "Drive data source." + ], + "type": "string" + }, + "matchInfo": { + "description": "List of matches that were found in the resource content.", + "items": { + "$ref": "MatchInfo" + }, + "type": "array" + }, + "recipients": { + "description": "Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "resourceInfo": { + "$ref": "ResourceInfo", + "description": "Details of the resource which violated the rule." + }, + "ruleInfo": { + "$ref": "RuleInfo", + "description": "Details of the violated rule." + }, + "suppressedActionTypes": { + "description": "Actions suppressed due to other actions with higher priority.", + "items": { + "enum": [ "ACTION_TYPE_UNSPECIFIED", "DRIVE_BLOCK_EXTERNAL_SHARING", "DRIVE_WARN_ON_EXTERNAL_SHARING", @@ -954,7 +1313,7 @@ "triggeredActionInfo": { "description": "Metadata related to the triggered actions.", "items": { - "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoActionInfo" + "$ref": "ActionInfo" }, "type": "array" }, @@ -988,97 +1347,61 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeRuleViolationInfoActionInfo": { - "description": "Metadata related to the action.", - "id": "GoogleAppsAlertcenterTypeRuleViolationInfoActionInfo", - "properties": {}, - "type": "object" - }, - "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfo": { - "description": "Proto that contains match information from the condition part of the rule.", - "id": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfo", - "properties": { - "predefinedDetector": { - "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoPredefinedDetectorInfo", - "description": "For matched detector predefined by Google." - }, - "userDefinedDetector": { - "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoUserDefinedDetectorInfo", - "description": "For matched detector defined by administrators." - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoPredefinedDetectorInfo": { - "description": "Detector provided by Google.", - "id": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoPredefinedDetectorInfo", + "Settings": { + "description": "Customer-level settings.", + "id": "Settings", "properties": { - "detectorName": { - "description": "Name that uniquely identifies the detector.", - "type": "string" + "notifications": { + "description": "The list of notifications.", + "items": { + "$ref": "Notification" + }, + "type": "array" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoUserDefinedDetectorInfo": { - "description": "Detector defined by administrators.", - "id": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoUserDefinedDetectorInfo", + "StateSponsoredAttack": { + "description": "A state-sponsored attack alert. Derived from audit logs.", + "id": "StateSponsoredAttack", "properties": { - "displayName": { - "description": "Display name of the detector.", - "type": "string" - }, - "resourceName": { - "description": "Resource name that uniquely identifies the detector.", + "email": { + "description": "The email of the user this incident was created for.", "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeRuleViolationInfoResourceInfo": { - "description": "Proto that contains resource information.", - "id": "GoogleAppsAlertcenterTypeRuleViolationInfoResourceInfo", + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", "properties": { - "documentId": { - "description": "Drive file ID.", - "type": "string" + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" }, - "resourceTitle": { - "description": "Title of the resource, for example email subject, or document title.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterTypeRuleViolationInfoRuleInfo": { - "description": "Proto that contains rule information.", - "id": "GoogleAppsAlertcenterTypeRuleViolationInfoRuleInfo", - "properties": { - "displayName": { - "description": "User provided name of the rule.", - "type": "string" + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" }, - "resourceName": { - "description": "Resource name that uniquely identifies the rule.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterTypeStateSponsoredAttack": { - "description": "A state-sponsored attack alert. Derived from audit logs.", - "id": "GoogleAppsAlertcenterTypeStateSponsoredAttack", - "properties": { - "email": { - "description": "The email of the user this incident was created for.", + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeSuspiciousActivity": { + "SuspiciousActivity": { "description": "A mobile suspicious activity alert. Derived from audit logs.", - "id": "GoogleAppsAlertcenterTypeSuspiciousActivity", + "id": "SuspiciousActivity", "properties": { "email": { "description": "The email of the user this alert was created for.", @@ -1087,16 +1410,16 @@ "events": { "description": "Required. The list of security events.", "items": { - "$ref": "GoogleAppsAlertcenterTypeSuspiciousActivitySuspiciousActivitySecurityDetail" + "$ref": "SuspiciousActivitySecurityDetail" }, "type": "array" } }, "type": "object" }, - "GoogleAppsAlertcenterTypeSuspiciousActivitySuspiciousActivitySecurityDetail": { + "SuspiciousActivitySecurityDetail": { "description": "Detailed information of a single MDM suspicious activity event.", - "id": "GoogleAppsAlertcenterTypeSuspiciousActivitySuspiciousActivitySecurityDetail", + "id": "SuspiciousActivitySecurityDetail", "properties": { "deviceId": { "description": "Required. The device ID.", @@ -1137,365 +1460,42 @@ }, "type": "object" }, - "GoogleAppsAlertcenterTypeUser": { - "description": "A user.", - "id": "GoogleAppsAlertcenterTypeUser", - "properties": { - "displayName": { - "description": "Display name of the user.", - "type": "string" - }, - "emailAddress": { - "description": "Email address of the user.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1Alert": { - "description": "An alert affecting a customer.", - "id": "GoogleAppsAlertcenterV1beta1Alert", - "properties": { - "alertId": { - "description": "Output only. The unique identifier for the alert.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time this alert was created.", - "format": "google-datetime", - "type": "string" - }, - "customerId": { - "description": "Output only. The unique identifier of the Google account of the customer.", - "type": "string" - }, - "data": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.", - "type": "object" - }, - "deleted": { - "description": "Output only. `True` if this alert is marked for deletion.", - "type": "boolean" - }, - "endTime": { - "description": "Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.", - "format": "google-datetime", - "type": "string" - }, - "etag": { - "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.", - "type": "string" - }, - "metadata": { - "$ref": "GoogleAppsAlertcenterV1beta1AlertMetadata", - "description": "Output only. The metadata associated with this alert." - }, - "securityInvestigationToolLink": { - "description": "Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.", - "type": "string" - }, - "source": { - "description": "Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity", - "type": "string" - }, - "startTime": { - "description": "Required. The time the event that caused this alert was started or detected.", - "format": "google-datetime", - "type": "string" - }, - "type": { - "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](/admin-sdk/alertcenter/reference/alert-types).", - "type": "string" - }, - "updateTime": { - "description": "Output only. The time this alert was last updated.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1AlertFeedback": { - "description": "A customer feedback about an alert.", - "id": "GoogleAppsAlertcenterV1beta1AlertFeedback", - "properties": { - "alertId": { - "description": "Output only. The alert identifier.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time this feedback was created.", - "format": "google-datetime", - "type": "string" - }, - "customerId": { - "description": "Output only. The unique identifier of the Google account of the customer.", - "type": "string" - }, - "email": { - "description": "Output only. The email of the user that provided the feedback.", - "type": "string" - }, - "feedbackId": { - "description": "Output only. The unique identifier for the feedback.", - "type": "string" - }, - "type": { - "description": "Required. The type of the feedback.", - "enum": [ - "ALERT_FEEDBACK_TYPE_UNSPECIFIED", - "NOT_USEFUL", - "SOMEWHAT_USEFUL", - "VERY_USEFUL" - ], - "enumDescriptions": [ - "The feedback type is not specified.", - "The alert report is not useful.", - "The alert report is somewhat useful.", - "The alert report is very useful." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1AlertMetadata": { - "description": "An alert metadata.", - "id": "GoogleAppsAlertcenterV1beta1AlertMetadata", - "properties": { - "alertId": { - "description": "Output only. The alert identifier.", - "type": "string" - }, - "assignee": { - "description": "The email address of the user assigned to the alert.", - "type": "string" - }, - "customerId": { - "description": "Output only. The unique identifier of the Google account of the customer.", - "type": "string" - }, - "etag": { - "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.", - "type": "string" - }, - "severity": { - "description": "The severity value of the alert. Alert Center will set this field at alert creation time, default's to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW", - "type": "string" - }, - "status": { - "description": "The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED", - "type": "string" - }, - "updateTime": { - "description": "Output only. The time this metadata was last updated.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsRequest": { - "description": "A request to perform batch delete on alerts.", - "id": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsRequest", - "properties": { - "alertId": { - "description": "Required. list of alert IDs.", - "items": { - "type": "string" - }, - "type": "array" - }, - "customerId": { - "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsResponse": { - "description": "Response to batch delete operation on alerts.", - "id": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsResponse", - "properties": { - "failedAlertStatus": { - "additionalProperties": { - "$ref": "GoogleRpcStatus" - }, - "description": "The status details for each failed alert_id.", - "type": "object" - }, - "successAlertIds": { - "description": "The successful list of alert IDs.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsRequest": { - "description": "A request to perform batch undelete on alerts.", - "id": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsRequest", + "UndeleteAlertRequest": { + "description": "A request to undelete a specific alert that was marked for deletion.", + "id": "UndeleteAlertRequest", "properties": { - "alertId": { - "description": "Required. list of alert IDs.", - "items": { - "type": "string" - }, - "type": "array" - }, "customerId": { - "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsResponse": { - "description": "Response to batch undelete operation on alerts.", - "id": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsResponse", - "properties": { - "failedAlertStatus": { - "additionalProperties": { - "$ref": "GoogleRpcStatus" - }, - "description": "The status details for each failed alert_id.", - "type": "object" - }, - "successAlertIds": { - "description": "The successful list of alert IDs.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1ListAlertFeedbackResponse": { - "description": "Response message for an alert feedback listing request.", - "id": "GoogleAppsAlertcenterV1beta1ListAlertFeedbackResponse", - "properties": { - "feedback": { - "description": "The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.", - "items": { - "$ref": "GoogleAppsAlertcenterV1beta1AlertFeedback" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1ListAlertsResponse": { - "description": "Response message for an alert listing request.", - "id": "GoogleAppsAlertcenterV1beta1ListAlertsResponse", - "properties": { - "alerts": { - "description": "The list of alerts.", - "items": { - "$ref": "GoogleAppsAlertcenterV1beta1Alert" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterV1beta1Settings": { - "description": "Customer-level settings.", - "id": "GoogleAppsAlertcenterV1beta1Settings", - "properties": { - "notifications": { - "description": "The list of notifications.", - "items": { - "$ref": "GoogleAppsAlertcenterV1beta1SettingsNotification" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1SettingsNotification": { - "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](/admin-sdk/alertcenter/guides/notifications).", - "id": "GoogleAppsAlertcenterV1beta1SettingsNotification", - "properties": { - "cloudPubsubTopic": { - "$ref": "GoogleAppsAlertcenterV1beta1SettingsNotificationCloudPubsubTopic", - "description": "A Google Cloud Pub/sub topic destination." - } - }, - "type": "object" - }, - "GoogleAppsAlertcenterV1beta1SettingsNotificationCloudPubsubTopic": { - "description": "A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.", - "id": "GoogleAppsAlertcenterV1beta1SettingsNotificationCloudPubsubTopic", + "User": { + "description": "A user.", + "id": "User", "properties": { - "payloadFormat": { - "description": "Optional. The format of the payload that would be sent. If not specified the format will be JSON.", - "enum": [ - "PAYLOAD_FORMAT_UNSPECIFIED", - "JSON" - ], - "enumDescriptions": [ - "Payload format is not specified (will use JSON as default).", - "Use JSON." - ], + "displayName": { + "description": "Display name of the user.", "type": "string" }, - "topicName": { - "description": "The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).", + "emailAddress": { + "description": "Email address of the user.", "type": "string" } }, "type": "object" }, - "GoogleAppsAlertcenterV1beta1UndeleteAlertRequest": { - "description": "A request to undelete a specific alert that was marked for deletion.", - "id": "GoogleAppsAlertcenterV1beta1UndeleteAlertRequest", + "UserDefinedDetectorInfo": { + "description": "Detector defined by administrators.", + "id": "UserDefinedDetectorInfo", "properties": { - "customerId": { - "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", + "displayName": { + "description": "Display name of the detector.", "type": "string" - } - }, - "type": "object" - }, - "GoogleProtobufEmpty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "GoogleProtobufEmpty", - "properties": {}, - "type": "object" - }, - "GoogleRpcStatus": { - "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": "GoogleRpcStatus", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "resourceName": { + "description": "Resource name that uniquely identifies the detector.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index c6ccce5bffa..84743cff5d2 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -787,34 +787,6 @@ "resources": { "androidAppDataStreams": { "methods": { - "create": { - "description": "Creates an Android app stream with the specified location and attributes. Note that an Android app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).", - "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams", - "httpMethod": "POST", - "id": "analyticsadmin.properties.androidAppDataStreams.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this android app data stream will be created. Format: properties/123", - "location": "path", - "pattern": "^properties/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/androidAppDataStreams", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, "delete": { "description": "Deletes an android app stream on a property.", "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}", @@ -1197,34 +1169,6 @@ }, "iosAppDataStreams": { "methods": { - "create": { - "description": "Creates an iOS app stream with the specified location and attributes. Note that an iOS app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).", - "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams", - "httpMethod": "POST", - "id": "analyticsadmin.properties.iosAppDataStreams.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this ios app data stream will be created. Format: properties/123", - "location": "path", - "pattern": "^properties/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/iosAppDataStreams", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, "delete": { "description": "Deletes an iOS app stream on a property.", "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}", @@ -1890,7 +1834,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccount": { @@ -2442,7 +2386,7 @@ "id": "GoogleAnalyticsAdminV1alphaGoogleAdsLink", "properties": { "adsPersonalizationEnabled": { - "description": "Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true.", + "description": "Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.", "type": "boolean" }, "canManageClients": { diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index adda45326ad..ff69e7e0b6e 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -284,7 +284,7 @@ } } }, - "revision": "20210408", + "revision": "20210424", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "BatchRunPivotReportsRequest": { diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index 0e1ceb7fdbd..abf944699b2 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -825,7 +825,7 @@ } } }, - "revision": "20210410", + "revision": "20210421", "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 8e5f134901c..72f45aff2c2 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2610,7 +2610,7 @@ } } }, - "revision": "20210324", + "revision": "20210422", "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 612688a57f8..16de2b793b0 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1004,7 +1004,7 @@ } } }, - "revision": "20210405", + "revision": "20210419", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdvancedSecurityOverrides": { diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 0bb9e4fa3af..6720f59b71e 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -2671,7 +2671,7 @@ } } }, - "revision": "20210407", + "revision": "20210427", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Apk": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index 6b28e0c8afa..32c88b505bb 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20210408", + "revision": "20210420", "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 f366e7fb95f..12e596b040a 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20210408", + "revision": "20210420", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 4218ebc0fcf..00817f75451 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -5707,12 +5707,6 @@ "parent" ], "parameters": { - "environments": { - "description": "Optional. List of environments that will be attached to the instance during creation.", - "location": "query", - "repeated": true, - "type": "string" - }, "parent": { "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.", "location": "path", @@ -6992,7 +6986,7 @@ } } }, - "revision": "20210403", + "revision": "20210422", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -10543,7 +10537,7 @@ "type": "string" }, "runtimeLocation": { - "description": "Cloud Platform location for the runtime instance. Defaults to `us-west1-a`.", + "description": "Cloud Platform location for the runtime instance. Defaults to zone `us-west1-a`. If a region is provided, `EVAL` organizations will use the region for automatically selecting a zone for the runtime instance.", "type": "string" } }, @@ -11587,6 +11581,20 @@ "format": "int32", "type": "integer" }, + "protocol": { + "description": "Immutable. The protocol used by this TargetServer.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "HTTP", + "GRPC" + ], + "enumDescriptions": [ + "UNSPECIFIED defaults to HTTP for backwards compatibility.", + "The TargetServer uses HTTP.", + "The TargetServer uses GRPC." + ], + "type": "string" + }, "sSLInfo": { "$ref": "GoogleCloudApigeeV1TlsInfo", "description": "Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration." @@ -11610,6 +11618,20 @@ "format": "int32", "type": "integer" }, + "protocol": { + "description": "The protocol used by this target server.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "HTTP", + "GRPC" + ], + "enumDescriptions": [ + "UNSPECIFIED defaults to HTTP for backwards compatibility.", + "The TargetServer uses HTTP.", + "The TargetServer uses GRPC." + ], + "type": "string" + }, "tlsInfo": { "$ref": "GoogleCloudApigeeV1TlsInfoConfig", "description": "TLS settings for the target server." @@ -11855,7 +11877,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json new file mode 100644 index 00000000000..63726f69d74 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -0,0 +1,730 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud Platform data" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://apikeys.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Api Keys Service", + "description": "Manages the API keys associated with developer projects.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/api-keys/docs", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "apikeys:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://apikeys.mtls.googleapis.com/", + "name": "apikeys", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "keys": { + "methods": { + "lookupKey": { + "description": "Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.", + "flatPath": "v2/keys:lookupKey", + "httpMethod": "GET", + "id": "apikeys.keys.lookupKey", + "parameterOrder": [], + "parameters": { + "keyString": { + "description": "Required. Finds the project that owns the key string value.", + "location": "query", + "type": "string" + } + }, + "path": "v2/keys:lookupKey", + "response": { + "$ref": "V2LookupKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v2/operations/{operationsId}", + "httpMethod": "GET", + "id": "apikeys.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "projects": { + "resources": { + "locations": { + "resources": { + "keys": { + "methods": { + "clone": { + "description": "Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:clone", + "httpMethod": "POST", + "id": "apikeys.projects.locations.keys.clone", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the API key to be cloned in the same project.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:clone", + "request": { + "$ref": "V2CloneKeyRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys", + "httpMethod": "POST", + "id": "apikeys.projects.locations.keys.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "keyId": { + "description": "User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project in which the API key is created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/keys", + "request": { + "$ref": "V2Key" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}", + "httpMethod": "DELETE", + "id": "apikeys.projects.locations.keys.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag known to the client for the expected state of the key. This is to be used for optimistic concurrency.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the API key to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}", + "httpMethod": "GET", + "id": "apikeys.projects.locations.keys.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the API key to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "V2Key" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "getKeyString": { + "description": "Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString", + "httpMethod": "GET", + "id": "apikeys.projects.locations.keys.getKeyString", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the API key to be retrieved.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}/keyString", + "response": { + "$ref": "V2GetKeyStringResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys", + "httpMethod": "GET", + "id": "apikeys.projects.locations.keys.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Only list keys that conform to the specified filter. The allowed filter strings are `state:ACTIVE` and `state:DELETED`. By default, ListKeys returns only active keys.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Specifies the maximum number of results to be returned at a time.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Requests a specific page of results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Lists all API keys associated with this project.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/keys", + "response": { + "$ref": "V2ListKeysResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}", + "httpMethod": "PATCH", + "id": "apikeys.projects.locations.keys.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: `display_name` and `restrictions`. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value \"*\", the service treats it equivalent to replace all allowed mutable fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "V2Key" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "undelete": { + "description": "Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete", + "httpMethod": "POST", + "id": "apikeys.projects.locations.keys.undelete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the API key to be undeleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:undelete", + "request": { + "$ref": "V2UndeleteKeyRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210426", + "rootUrl": "https://apikeys.googleapis.com/", + "schemas": { + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "V2AndroidApplication": { + "description": "Identifier of an Android application for key use.", + "id": "V2AndroidApplication", + "properties": { + "packageName": { + "description": "The package name of the application.", + "type": "string" + }, + "sha1Fingerprint": { + "description": "The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.", + "type": "string" + } + }, + "type": "object" + }, + "V2AndroidKeyRestrictions": { + "description": "The Android apps that are allowed to use the key.", + "id": "V2AndroidKeyRestrictions", + "properties": { + "allowedApplications": { + "description": "A list of Android applications that are allowed to make API calls with this key.", + "items": { + "$ref": "V2AndroidApplication" + }, + "type": "array" + } + }, + "type": "object" + }, + "V2ApiTarget": { + "description": "A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.", + "id": "V2ApiTarget", + "properties": { + "methods": { + "description": "Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*`", + "items": { + "type": "string" + }, + "type": "array" + }, + "service": { + "description": "The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.", + "type": "string" + } + }, + "type": "object" + }, + "V2BrowserKeyRestrictions": { + "description": "The HTTP referrers (websites) that are allowed to use the key.", + "id": "V2BrowserKeyRestrictions", + "properties": { + "allowedReferrers": { + "description": "A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "V2CloneKeyRequest": { + "description": "Request message for `CloneKey` method.", + "id": "V2CloneKeyRequest", + "properties": { + "keyId": { + "description": "User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.", + "type": "string" + } + }, + "type": "object" + }, + "V2GetKeyStringResponse": { + "description": "Response message for `GetKeyString` method.", + "id": "V2GetKeyStringResponse", + "properties": { + "keyString": { + "description": "An encrypted and signed value of the key.", + "type": "string" + } + }, + "type": "object" + }, + "V2IosKeyRestrictions": { + "description": "The iOS apps that are allowed to use the key.", + "id": "V2IosKeyRestrictions", + "properties": { + "allowedBundleIds": { + "description": "A list of bundle IDs that are allowed when making API calls with this key.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "V2Key": { + "description": "The representation of a key managed by the API Keys API.", + "id": "V2Key", + "properties": { + "createTime": { + "description": "Output only. A timestamp identifying the time this key was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Human-readable display name of this key that you can modify. The maximum length is 63 characters.", + "type": "string" + }, + "etag": { + "description": "Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "readOnly": true, + "type": "string" + }, + "keyString": { + "description": "Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.", + "readOnly": true, + "type": "string" + }, + "restrictions": { + "$ref": "V2Restrictions", + "description": "Key restrictions." + }, + "uid": { + "description": "Output only. Unique id in UUID4 format.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. A timestamp identifying the time this key was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "V2ListKeysResponse": { + "description": "Response message for `ListKeys` method.", + "id": "V2ListKeysResponse", + "properties": { + "keys": { + "description": "A list of API keys.", + "items": { + "$ref": "V2Key" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The pagination token for the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "V2LookupKeyResponse": { + "description": "Response message for `LookupKey` method.", + "id": "V2LookupKeyResponse", + "properties": { + "name": { + "description": "The resource name of the API key. If the API key has been purged, resource name is empty.", + "type": "string" + }, + "parent": { + "description": "The project that owns the key with the value specified in the request.", + "type": "string" + } + }, + "type": "object" + }, + "V2Restrictions": { + "description": "Describes the restrictions on the key.", + "id": "V2Restrictions", + "properties": { + "androidKeyRestrictions": { + "$ref": "V2AndroidKeyRestrictions", + "description": "The Android apps that are allowed to use the key." + }, + "apiTargets": { + "description": "A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.", + "items": { + "$ref": "V2ApiTarget" + }, + "type": "array" + }, + "browserKeyRestrictions": { + "$ref": "V2BrowserKeyRestrictions", + "description": "The HTTP referrers (websites) that are allowed to use the key." + }, + "iosKeyRestrictions": { + "$ref": "V2IosKeyRestrictions", + "description": "The iOS apps that are allowed to use the key." + }, + "serverKeyRestrictions": { + "$ref": "V2ServerKeyRestrictions", + "description": "The IP addresses of callers that are allowed to use the key." + } + }, + "type": "object" + }, + "V2ServerKeyRestrictions": { + "description": "The IP addresses of callers that are allowed to use the key.", + "id": "V2ServerKeyRestrictions", + "properties": { + "allowedIps": { + "description": "A list of the caller IP addresses that are allowed to make API calls with this key.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "V2UndeleteKeyRequest": { + "description": "Request message for `UndeleteKey` method.", + "id": "V2UndeleteKeyRequest", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "API Keys API", + "version": "v2", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index bbc3c2d46ba..1beffee2271 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1594,7 +1594,7 @@ } } }, - "revision": "20210410", + "revision": "20210417", "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 0c890037345..eb6fe4d22e5 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -708,7 +708,7 @@ } } }, - "revision": "20210410", + "revision": "20210417", "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 8b7c7511e11..630fef06486 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1594,7 +1594,7 @@ } } }, - "revision": "20210410", + "revision": "20210417", "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 ed0f6b07bcc..999bba13d8a 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -159,6 +159,11 @@ "id": "area120tables.tables.list", "parameterOrder": [], "parameters": { + "orderBy": { + "description": "Optional. Sorting order for the list of tables on createTime/updateTime.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.", "format": "int32", @@ -410,6 +415,11 @@ "location": "query", "type": "string" }, + "orderBy": { + "description": "Optional. Sorting order for the list of rows on createTime/updateTime.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.", "format": "int32", @@ -576,7 +586,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { @@ -672,6 +682,10 @@ "$ref": "LookupDetails", "description": "Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column." }, + "multipleValuesDisallowed": { + "description": "Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible.", + "type": "boolean" + }, "name": { "description": "column name", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index f3787a750c5..39cc3852c55 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -283,7 +283,7 @@ } } }, - "revision": "20210324", + "revision": "20210415", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index 898f50a951c..72b21a24a13 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -160,7 +160,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -971,7 +971,7 @@ } } }, - "revision": "20210324", + "revision": "20210415", "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 1b1168e9536..fcaee38385b 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -160,7 +160,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -971,7 +971,7 @@ } } }, - "revision": "20210324", + "revision": "20210415", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { @@ -1472,6 +1472,15 @@ "description": "Optional. Description of the version, as specified in its metadata.", "type": "string" }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the only resource in use is DockerImage", + "readOnly": true, + "type": "object" + }, "name": { "description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\".", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index ae1f46d396f..84678556be4 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -351,7 +351,7 @@ } } }, - "revision": "20210330", + "revision": "20210426", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": { @@ -366,7 +366,9 @@ "CJIS", "FEDRAMP_HIGH", "FEDRAMP_MODERATE", - "US_REGIONAL_ACCESS" + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -374,7 +376,9 @@ "Criminal Justice Information Services (CJIS) Security policies.", "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", - "Assured Workloads For US Regions data protection controls" + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls" ], "type": "string" }, @@ -428,7 +432,9 @@ "CJIS", "FEDRAMP_HIGH", "FEDRAMP_MODERATE", - "US_REGIONAL_ACCESS" + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -436,7 +442,9 @@ "Criminal Justice Information Services (CJIS) Security policies.", "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", - "Assured Workloads For US Regions data protection controls" + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls" ], "type": "string" }, @@ -522,12 +530,14 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", - "ENCRYPTION_KEYS_PROJECT" + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" ], "enumDescriptions": [ "Unknown resource type.", "Consumer project.", - "Consumer project containing encryption keys." + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." ], "type": "string" } @@ -547,12 +557,14 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", - "ENCRYPTION_KEYS_PROJECT" + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" ], "enumDescriptions": [ "Unknown resource type.", "Consumer project.", - "Consumer project containing encryption keys." + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." ], "type": "string" } @@ -777,12 +789,14 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", - "ENCRYPTION_KEYS_PROJECT" + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" ], "enumDescriptions": [ "Unknown resource type.", "Consumer project.", - "Consumer project containing encryption keys." + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." ], "type": "string" } @@ -802,12 +816,14 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", - "ENCRYPTION_KEYS_PROJECT" + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" ], "enumDescriptions": [ "Unknown resource type.", "Consumer project.", - "Consumer project containing encryption keys." + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index e965bbc4422..66c2c1ca2ce 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -713,7 +713,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -760,7 +759,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -954,7 +952,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1049,7 +1046,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1129,7 +1125,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1184,7 +1179,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1244,7 +1238,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1465,7 +1458,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1643,7 +1635,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1692,7 +1683,7 @@ } } }, - "revision": "20210404", + "revision": "20210416", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -5385,6 +5376,7 @@ "GEOGRAPHY", "NUMERIC", "BIGNUMERIC", + "JSON", "ARRAY", "STRUCT" ], @@ -5403,6 +5395,7 @@ "Encoded as WKT", "Encoded as a decimal string.", "Encoded as a decimal string.", + "Encoded as a string.", "Encoded as a list with types matching Type.array_type.", "Encoded as a list with fields of type Type.struct_type[i]. List is used because a JSON object cannot have duplicate field names." ], @@ -5756,7 +5749,7 @@ "type": "string" }, "name": { - "description": "[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.", + "description": "[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.", "type": "string" }, "policyTags": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json index 36d659b2161..f2c7f37ba28 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json @@ -395,7 +395,7 @@ } } }, - "revision": "20210403", + "revision": "20210416", "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 edc2d8f6d20..6c0ff033396 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -5,9 +5,6 @@ "https://www.googleapis.com/auth/bigquery": { "description": "View and manage your data in Google BigQuery" }, - "https://www.googleapis.com/auth/bigquery.readonly": { - "description": "View your data in Google BigQuery" - }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud Platform data" }, @@ -144,7 +141,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -172,7 +168,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -211,7 +206,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -243,7 +237,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -270,7 +263,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -287,7 +280,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -322,7 +314,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -350,7 +341,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -389,7 +379,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -490,7 +479,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -535,7 +523,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -700,7 +687,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -774,7 +760,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -835,7 +820,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -942,7 +926,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -987,7 +970,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1152,7 +1134,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1226,7 +1207,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1287,7 +1267,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/bigquery.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -1301,7 +1280,7 @@ } } }, - "revision": "20210404", + "revision": "20210418", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 6418beac4af..dbafe30fca5 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -270,6 +270,11 @@ "parent" ], "parameters": { + "capacityCommitmentId": { + "description": "The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.", + "location": "query", + "type": "string" + }, "enforceSingleAdminProjectPerOrg": { "description": "If true, fail the request if another project in the organization has a capacity commitment.", "location": "query", @@ -652,6 +657,11 @@ "parent" ], "parameters": { + "assignmentId": { + "description": "The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters.", + "location": "query", + "type": "string" + }, "parent": { "description": "Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod`", "location": "path", @@ -763,6 +773,41 @@ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates an existing assignment. Only the `priority` field can be updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}", + "httpMethod": "PATCH", + "id": "bigqueryreservation.projects.locations.reservations.assignments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Assignment" + }, + "response": { + "$ref": "Assignment" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -773,7 +818,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "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 1d5cbee6fc0..c62e905b9ce 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json @@ -228,6 +228,11 @@ "parent" ], "parameters": { + "capacityCommitmentId": { + "description": "The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.", + "location": "query", + "type": "string" + }, "enforceSingleAdminProjectPerOrg": { "description": "If true, fail the request if another project in the organization has a capacity commitment.", "location": "query", @@ -615,6 +620,11 @@ "parent" ], "parameters": { + "assignmentId": { + "description": "The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters.", + "location": "query", + "type": "string" + }, "parent": { "description": "Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod`", "location": "path", @@ -726,6 +736,41 @@ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates an existing assignment. Only the `priority` field can be updated.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}", + "httpMethod": "PATCH", + "id": "bigqueryreservation.projects.locations.reservations.assignments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "Assignment" + }, + "response": { + "$ref": "Assignment" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -736,7 +781,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -994,11 +1039,6 @@ "description": "If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.", "type": "boolean" }, - "maxConcurrency": { - "description": "Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size.", - "format": "int64", - "type": "string" - }, "name": { "description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v1.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v1.json index a4803bc42a9..1b442957307 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v1.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v1.json @@ -96,7 +96,7 @@ }, "protocol": "rest", "resources": {}, - "revision": "20210314", + "revision": "20210405", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "Backup": { diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index ad075b3ec51..c56d93a4510 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -24,7 +24,7 @@ "description": "Administer your Cloud Bigtable tables" }, "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud Platform services" @@ -923,8 +923,47 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "partialUpdateCluster": { + "description": "Partially updates a cluster within a project. This method is the preferred way to update a Cluster. ", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}", + "httpMethod": "PATCH", + "id": "bigtableadmin.projects.instances.clusters.partialUpdateCluster", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The subset of Cluster fields which should be replaced. Must be explicitly set.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "update": { - "description": "Updates a cluster within an instance.", + "description": "Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}", "httpMethod": "PUT", "id": "bigtableadmin.projects.instances.clusters.update", @@ -1433,7 +1472,7 @@ "Only populates `name`.", "Only populates `name` and fields related to the table's schema.", "Only populates `name` and fields related to the table's replication state.", - "Only populates 'name' and fields related to the table's encryption state.", + "Only populates `name` and fields related to the table's encryption state.", "Populates all fields." ], "location": "query", @@ -1527,7 +1566,7 @@ "Only populates `name`.", "Only populates `name` and fields related to the table's schema.", "Only populates `name` and fields related to the table's replication state.", - "Only populates 'name' and fields related to the table's encryption state.", + "Only populates `name` and fields related to the table's encryption state.", "Populates all fields." ], "location": "query", @@ -1764,7 +1803,7 @@ } } }, - "revision": "20210314", + "revision": "20210405", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json index 16c2a99cf53..d4a1362eb96 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json @@ -270,7 +270,7 @@ } } }, - "revision": "20210403", + "revision": "20210424", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1Budget": { @@ -347,7 +347,7 @@ "id": "GoogleCloudBillingBudgetsV1Filter", "properties": { "calendarPeriod": { - "description": "Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on.", + "description": "Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.", "enum": [ "CALENDAR_PERIOD_UNSPECIFIED", "MONTH", @@ -363,7 +363,7 @@ "type": "string" }, "creditTypes": { - "description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).", + "description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.", "items": { "type": "string" }, @@ -381,13 +381,13 @@ "", "All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.", "All types of credit are added to the net cost to determine the spend for threshold calculations.", - "Credit types specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations." + "[Credit types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations." ], "type": "string" }, "customPeriod": { "$ref": "GoogleCloudBillingBudgetsV1CustomPeriod", - "description": "Optional. Specifies to track usage from any start date (required) to any end date (optional)." + "description": "Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur." }, "labels": { "additionalProperties": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json index beeec76927e..e8f91d6c9b4 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json @@ -264,7 +264,7 @@ } } }, - "revision": "20210403", + "revision": "20210424", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": { @@ -378,7 +378,7 @@ "id": "GoogleCloudBillingBudgetsV1beta1Filter", "properties": { "calendarPeriod": { - "description": "Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on.", + "description": "Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.", "enum": [ "CALENDAR_PERIOD_UNSPECIFIED", "MONTH", @@ -394,7 +394,7 @@ "type": "string" }, "creditTypes": { - "description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).", + "description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.", "items": { "type": "string" }, @@ -412,13 +412,13 @@ "", "All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.", "All types of credit are added to the net cost to determine the spend for threshold calculations.", - "Credit types specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations." + "[Credit types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations." ], "type": "string" }, "customPeriod": { "$ref": "GoogleCloudBillingBudgetsV1beta1CustomPeriod", - "description": "Optional. Specifies to track usage from any start date (required) to any end date (optional)." + "description": "Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur." }, "labels": { "additionalProperties": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json index e724c45cf16..4659231473c 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json index bd22068950f..78513f58655 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v2.json b/googleapiclient/discovery_cache/documents/blogger.v2.json index 805675f7a20..6b8348e2651 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "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 169eb87bd0b..539948aa610 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1678,7 +1678,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/books.v1.json b/googleapiclient/discovery_cache/documents/books.v1.json index 10500b20f39..29c8fc87dfc 100644 --- a/googleapiclient/discovery_cache/documents/books.v1.json +++ b/googleapiclient/discovery_cache/documents/books.v1.json @@ -2671,7 +2671,7 @@ } } }, - "revision": "20210407", + "revision": "20210426", "rootUrl": "https://books.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 9c9c75587e4..9c2f82716cb 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1723,7 +1723,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2074,9 +2074,9 @@ "calendar": { "additionalProperties": { "$ref": "ColorDefinition", - "description": "A calendar color defintion." + "description": "A calendar color definition." }, - "description": "A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only.", + "description": "A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only.", "type": "object" }, "event": { @@ -2084,7 +2084,7 @@ "$ref": "ColorDefinition", "description": "An event color definition." }, - "description": "A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only.", + "description": "A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only.", "type": "object" }, "kind": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 446f33306c0..35f678de311 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -3,7 +3,7 @@ "baseUrl": "https://chat.googleapis.com/", "batchPath": "batch", "canonicalName": "Hangouts Chat", - "description": "Enables bots to fetch information and perform actions in Google Chat.", + "description": "Enables bots to fetch information and perform actions in Google Chat. Authentication using a service account is a prerequisite for using the Google Chat REST API.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/hangouts/chat", "fullyEncodeReservedExpansion": true, @@ -601,7 +601,7 @@ } } }, - "revision": "20210403", + "revision": "20210421", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 70b4a726ffc..11af03f4c8b 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -288,7 +288,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1BrowserVersion": { diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index b2a1b55e460..88ad33a0147 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyV1AdditionalTargetKeyName": { diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index 3ba0679719a..7bb1f725e09 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20210408", + "revision": "20210426", "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 b838f87bfb4..e7abf6b83c6 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -2400,7 +2400,7 @@ } } }, - "revision": "20210406", + "revision": "20210421", "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 df0b23e0dca..25afe92fb86 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -553,7 +553,7 @@ "type": "string" }, "query": { - "description": "Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Cloud resources whose name contains \"Important\" as a word. * `name=Important` to find the Cloud resource whose name is exactly \"Important\". * `displayName:Impor*` to find Cloud resources whose display name contains \"Impor\" as a prefix of any word in the field. * `location:us-west*` to find Cloud resources whose location contains both \"us\" and \"west\" as prefixes. * `labels:prod` to find Cloud resources whose labels contain \"prod\" as a key or value. * `labels.env:prod` to find Cloud resources that have a label \"env\" and its value is \"prod\". * `labels.env:*` to find Cloud resources that have a label \"env\". * `kmsKey:key` to find Cloud resources encrypted with a customer-managed encryption key whose name contains the word \"key\". * `state:ACTIVE` to find Cloud resources whose state contains \"ACTIVE\" as a word. * `createTime<1609459200` to find Cloud resources that were created before \"2021-01-01 00:00:00 UTC\". 1609459200 is the epoch timestamp of \"2021-01-01 00:00:00 UTC\" in seconds. * `updateTime>1609459200` to find Cloud resources that were updated after \"2021-01-01 00:00:00 UTC\". 1609459200 is the epoch timestamp of \"2021-01-01 00:00:00 UTC\" in seconds. * `Important` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields. * `Impor*` to find Cloud resources that contain \"Impor\" as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields and are also located in the \"us-west1\" region or the \"global\" location.", + "description": "Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Cloud resources whose name contains \"Important\" as a word. * `name=Important` to find the Cloud resource whose name is exactly \"Important\". * `displayName:Impor*` to find Cloud resources whose display name contains \"Impor\" as a prefix of any word in the field. * `location:us-west*` to find Cloud resources whose location contains both \"us\" and \"west\" as prefixes. * `labels:prod` to find Cloud resources whose labels contain \"prod\" as a key or value. * `labels.env:prod` to find Cloud resources that have a label \"env\" and its value is \"prod\". * `labels.env:*` to find Cloud resources that have a label \"env\". * `kmsKey:key` to find Cloud resources encrypted with a customer-managed encryption key whose name contains the word \"key\". * `state:ACTIVE` to find Cloud resources whose state contains \"ACTIVE\" as a word. * `NOT state:ACTIVE` to find {{gcp_name}} resources whose state doesn't contain \"ACTIVE\" as a word. * `createTime<1609459200` to find Cloud resources that were created before \"2021-01-01 00:00:00 UTC\". 1609459200 is the epoch timestamp of \"2021-01-01 00:00:00 UTC\" in seconds. * `updateTime>1609459200` to find Cloud resources that were updated after \"2021-01-01 00:00:00 UTC\". 1609459200 is the epoch timestamp of \"2021-01-01 00:00:00 UTC\" in seconds. * `Important` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields. * `Impor*` to find Cloud resources that contain \"Impor\" as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields and are also located in the \"us-west1\" region or the \"global\" location.", "location": "query", "type": "string" }, @@ -576,7 +576,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1657,7 +1657,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressFrom": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { @@ -1702,18 +1702,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressTo": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.", "id": "GoogleIdentityAccesscontextmanagerV1EgressTo", "properties": { "operations": { - "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.", "items": { "type": "string" }, @@ -1723,7 +1723,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressFrom": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { @@ -1779,7 +1779,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, "resource": { @@ -1790,18 +1790,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressTo": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressTo", "properties": { "operations": { - "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.", "items": { "type": "string" }, @@ -2114,7 +2114,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 18586b492ad..c1c529bb005 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningResponse": { @@ -1092,7 +1092,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressFrom": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { @@ -1137,18 +1137,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressTo": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.", "id": "GoogleIdentityAccesscontextmanagerV1EgressTo", "properties": { "operations": { - "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.", "items": { "type": "string" }, @@ -1158,7 +1158,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressFrom": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { @@ -1214,7 +1214,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, "resource": { @@ -1225,18 +1225,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressTo": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressTo", "properties": { "operations": { - "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index 68dff86647b..463c8297be1 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningResponse": { @@ -794,7 +794,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressFrom": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { @@ -839,18 +839,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressTo": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.", "id": "GoogleIdentityAccesscontextmanagerV1EgressTo", "properties": { "operations": { - "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.", "items": { "type": "string" }, @@ -860,7 +860,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressFrom": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { @@ -916,7 +916,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, "resource": { @@ -927,18 +927,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressTo": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressTo", "properties": { "operations": { - "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json index 88deb917fbf..8497e3d0d42 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json @@ -221,7 +221,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -490,7 +490,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", @@ -1039,7 +1039,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressFrom": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { @@ -1084,18 +1084,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressTo": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.", "id": "GoogleIdentityAccesscontextmanagerV1EgressTo", "properties": { "operations": { - "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.", "items": { "type": "string" }, @@ -1105,7 +1105,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressFrom": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { @@ -1161,7 +1161,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, "resource": { @@ -1172,18 +1172,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressTo": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressTo", "properties": { "operations": { - "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index fa32ead6769..aa4462969d7 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningResponse": { @@ -799,7 +799,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressFrom": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { @@ -844,18 +844,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressTo": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.", "id": "GoogleIdentityAccesscontextmanagerV1EgressTo", "properties": { "operations": { - "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.", "items": { "type": "string" }, @@ -865,7 +865,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressFrom": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { @@ -921,7 +921,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, "resource": { @@ -932,18 +932,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressTo": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressTo", "properties": { "operations": { - "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index 0be8d073bd6..383994c90da 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningResponse": { @@ -868,7 +868,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressFrom": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { @@ -913,18 +913,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1EgressTo": { - "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.", "id": "GoogleIdentityAccesscontextmanagerV1EgressTo", "properties": { "operations": { - "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.", "items": { "type": "string" }, @@ -934,7 +934,7 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressFrom": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { @@ -990,7 +990,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressSource", "properties": { "accessLevel": { - "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, "resource": { @@ -1001,18 +1001,18 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1IngressTo": { - "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.", "id": "GoogleIdentityAccesscontextmanagerV1IngressTo", "properties": { "operations": { - "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" }, "type": "array" }, "resources": { - "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 4b31ea3603a..fa0b302b28e 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -819,7 +819,7 @@ } } }, - "revision": "20210402", + "revision": "20210415", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { @@ -1321,6 +1321,10 @@ "description": "Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml).", "type": "string" }, + "filter": { + "description": "Optional. A Common Expression Language string.", + "type": "string" + }, "github": { "$ref": "GitHubEventsConfig", "description": "GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`." @@ -1348,6 +1352,10 @@ "description": "User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character.", "type": "string" }, + "pubsubConfig": { + "$ref": "PubsubConfig", + "description": "Optional. PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published." + }, "substitutions": { "additionalProperties": { "type": "string" @@ -1729,6 +1737,44 @@ }, "type": "object" }, + "PubsubConfig": { + "description": "PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.", + "id": "PubsubConfig", + "properties": { + "serviceAccountEmail": { + "description": "Service account that will make the push request.", + "type": "string" + }, + "state": { + "description": "Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests.", + "enum": [ + "STATE_UNSPECIFIED", + "OK", + "SUBSCRIPTION_DELETED", + "TOPIC_DELETED", + "SUBSCRIPTION_MISCONFIGURED" + ], + "enumDescriptions": [ + "The subscription configuration has not been checked.", + "The Pub/Sub subscription is properly configured.", + "The subscription has been deleted.", + "The topic has been deleted.", + "Some of the subscription's field are misconfigured." + ], + "type": "string" + }, + "subscription": { + "description": "Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`.", + "readOnly": true, + "type": "string" + }, + "topic": { + "description": "The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`.", + "type": "string" + } + }, + "type": "object" + }, "PullRequestFilter": { "description": "PullRequestFilter contains filter properties for matching GitHub Pull Requests.", "id": "PullRequestFilter", diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json index 28263dd770d..6a7c3bdefe5 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json @@ -306,7 +306,7 @@ } } }, - "revision": "20210402", + "revision": "20210415", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json index 89ff27d657c..b1f55d34d6f 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json @@ -317,7 +317,7 @@ } } }, - "revision": "20210402", + "revision": "20210415", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json index 018fa86c3b8..8d09c1062b9 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json @@ -317,7 +317,7 @@ } } }, - "revision": "20210402", + "revision": "20210415", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index ab842412644..84630cb2a04 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -1508,7 +1508,7 @@ } } }, - "revision": "20210408", + "revision": "20210423", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -2172,7 +2172,8 @@ "SKU_CHANGED", "RENEWAL_SETTING_CHANGED", "PAID_SERVICE_STARTED", - "LICENSE_ASSIGNMENT_CHANGED" + "LICENSE_ASSIGNMENT_CHANGED", + "LICENSE_CAP_CHANGED" ], "enumDescriptions": [ "Default value. This state doesn't show unless an error occurs.", @@ -2186,7 +2187,8 @@ "Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).", "The renewal settings of an entitlement has changed.", "Paid service has started on trial entitlement.", - "License was assigned to or revoked from a user." + "License was assigned to or revoked from a user.", + "License cap was changed for the entitlement." ], "type": "string" } @@ -3473,7 +3475,8 @@ "SKU_CHANGED", "RENEWAL_SETTING_CHANGED", "PAID_SERVICE_STARTED", - "LICENSE_ASSIGNMENT_CHANGED" + "LICENSE_ASSIGNMENT_CHANGED", + "LICENSE_CAP_CHANGED" ], "enumDescriptions": [ "Default value. This state doesn't show unless an error occurs.", @@ -3487,7 +3490,8 @@ "Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).", "The renewal settings of an entitlement has changed.", "Paid service has started on trial entitlement.", - "License was assigned to or revoked from a user." + "License was assigned to or revoked from a user.", + "License cap was changed for the entitlement." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json new file mode 100644 index 00000000000..11c978f50d2 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json @@ -0,0 +1,882 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud Platform data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://cloudcommerceprocurement.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Commerce Partner Procurement Service", + "description": "Partner API for the Cloud Commerce Procurement Service.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/marketplace/docs/partners/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "cloudcommerceprocurement:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudcommerceprocurement.mtls.googleapis.com/", + "name": "cloudcommerceprocurement", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "providers": { + "resources": { + "accounts": { + "methods": { + "approve": { + "description": "Grants an approval on an Account.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:approve", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.accounts.approve", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the account. Required.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:approve", + "request": { + "$ref": "ApproveAccountRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a requested Account resource.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the account to retrieve.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Accounts that the provider has access to.", + "flatPath": "v1/providers/{providersId}/accounts", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.accounts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of entries that are requested. Default size is 200.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token for fetching the next page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent resource name.", + "location": "path", + "pattern": "^providers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/accounts", + "response": { + "$ref": "ListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reject": { + "description": "Rejects an approval on an Account.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reject", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.accounts.reject", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the account. Required.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reject", + "request": { + "$ref": "RejectAccountRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reset": { + "description": "Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.", + "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reset", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.accounts.reset", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the account. Required.", + "location": "path", + "pattern": "^providers/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reset", + "request": { + "$ref": "ResetAccountRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "entitlements": { + "methods": { + "approve": { + "description": "Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approve", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.approve", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the entitlement. Required.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:approve", + "request": { + "$ref": "ApproveEntitlementRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "approvePlanChange": { + "description": "Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.approvePlanChange", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the entitlement. Required.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:approvePlanChange", + "request": { + "$ref": "ApproveEntitlementPlanChangeRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a requested Entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.entitlements.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the entitlement to retrieve.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Entitlement" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Entitlements for which the provider has read access.", + "flatPath": "v1/providers/{providersId}/entitlements", + "httpMethod": "GET", + "id": "cloudcommerceprocurement.providers.entitlements.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` Note that the consumers match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. Also note that the state name match is case-insensitive and query can omit the prefix \"ENTITLEMENT_\". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product=\"providerId:productId\"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of entries that are requested.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token for fetching the next page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent resource name.", + "location": "path", + "pattern": "^providers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entitlements", + "response": { + "$ref": "ListEntitlementsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing Entitlement.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", + "httpMethod": "PATCH", + "id": "cloudcommerceprocurement.providers.entitlements.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the entitlement to update.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Entitlement" + }, + "response": { + "$ref": "Entitlement" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reject": { + "description": "Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:reject", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.reject", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the entitlement. Required.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reject", + "request": { + "$ref": "RejectEntitlementRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rejectPlanChange": { + "description": "Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.rejectPlanChange", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the entitlement. Required.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:rejectPlanChange", + "request": { + "$ref": "RejectEntitlementPlanChangeRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "suspend": { + "description": "Requests suspension of an active Entitlement. This is not yet supported.", + "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:suspend", + "httpMethod": "POST", + "id": "cloudcommerceprocurement.providers.entitlements.suspend", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the entitlement to suspend.", + "location": "path", + "pattern": "^providers/[^/]+/entitlements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:suspend", + "request": { + "$ref": "SuspendEntitlementRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20210410", + "rootUrl": "https://cloudcommerceprocurement.googleapis.com/", + "schemas": { + "Account": { + "description": "Represents an account that was established by the customer on the service provider's system.", + "id": "Account", + "properties": { + "approvals": { + "description": "Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.", + "items": { + "$ref": "Approval" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The creation timestamp.", + "format": "google-datetime", + "type": "string" + }, + "inputProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. The custom properties that were collected from the user to create this account.", + "type": "object" + }, + "name": { + "description": "Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.", + "type": "string" + }, + "provider": { + "description": "Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.", + "enum": [ + "ACCOUNT_STATE_UNSPECIFIED", + "ACCOUNT_ACTIVATION_REQUESTED", + "ACCOUNT_ACTIVE" + ], + "enumDescriptions": [ + "Default state of the account. It's only set to this value when the account is first created and has not been initialized.", + "The customer has requested the creation of the account resource, and the provider notification message is dispatched. This state has been deprecated, as accounts now immediately transition to AccountState.ACCOUNT_ACTIVE.", + "The account is active and ready for use. The next possible states are: - Account getting deleted: After the user invokes delete from another API." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update timestamp.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "Approval": { + "description": "An approval for some action on an account.", + "id": "Approval", + "properties": { + "name": { + "description": "Output only. The name of the approval.", + "type": "string" + }, + "reason": { + "description": "Output only. An explanation for the state of the approval.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the approval.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "APPROVED", + "REJECTED" + ], + "enumDescriptions": [ + "Sentinel value; do not use.", + "The approval is pending response from the provider. The approval state can transition to Account.Approval.State.APPROVED or Account.Approval.State.REJECTED.", + "The approval has been granted by the provider.", + "The approval has been rejected by the provider. A provider may choose to approve a previously rejected approval, so is it possible to transition to Account.Approval.State.APPROVED." + ], + "type": "string" + }, + "updateTime": { + "description": "Optional. The last update timestamp of the approval.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ApproveAccountRequest": { + "description": "Request message for PartnerProcurementService.ApproveAccount.", + "id": "ApproveAccountRequest", + "properties": { + "approvalName": { + "description": "The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of properties that should be associated with the account. Optional.", + "type": "object" + }, + "reason": { + "description": "Free form text string explaining the approval reason. Optional. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "ApproveEntitlementPlanChangeRequest": { + "description": "Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].", + "id": "ApproveEntitlementPlanChangeRequest", + "properties": { + "pendingPlanName": { + "description": "Name of the pending plan that is being approved. Required.", + "type": "string" + } + }, + "type": "object" + }, + "ApproveEntitlementRequest": { + "description": "Request message for [PartnerProcurementService.ApproveEntitlement[].", + "id": "ApproveEntitlementRequest", + "properties": { + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of properties that should be associated with the entitlement. Optional.", + "type": "object" + } + }, + "type": "object" + }, + "Consumer": { + "description": "A resource using (consuming) this entitlement.", + "id": "Consumer", + "properties": { + "project": { + "description": "A project name with format `projects/`.", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Entitlement": { + "description": "Represents a procured product of a customer. Next Id: 23", + "id": "Entitlement", + "properties": { + "account": { + "description": "Output only. The resource name of the account that this entitlement is based on, if any.", + "type": "string" + }, + "consumers": { + "description": "Output only. The resources using this entitlement, if applicable.", + "items": { + "$ref": "Consumer" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The creation timestamp.", + "format": "google-datetime", + "type": "string" + }, + "inputProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. The custom properties that were collected from the user to create this entitlement.", + "type": "object" + }, + "messageToUser": { + "description": "Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.", + "type": "string" + }, + "newPendingOffer": { + "description": "Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.", + "readOnly": true, + "type": "string" + }, + "newPendingPlan": { + "description": "Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.", + "type": "string" + }, + "offer": { + "description": "Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.", + "readOnly": true, + "type": "string" + }, + "offerEndTime": { + "description": "Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "plan": { + "description": "Output only. The identifier of the plan that was procured. Required if the product has plans.", + "type": "string" + }, + "product": { + "description": "Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.", + "type": "string" + }, + "productExternalName": { + "description": "Output only. The identifier of the product that was procured.", + "readOnly": true, + "type": "string" + }, + "provider": { + "description": "Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", + "type": "string" + }, + "quoteExternalName": { + "description": "Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the entitlement.", + "enum": [ + "ENTITLEMENT_STATE_UNSPECIFIED", + "ENTITLEMENT_ACTIVATION_REQUESTED", + "ENTITLEMENT_ACTIVE", + "ENTITLEMENT_PENDING_CANCELLATION", + "ENTITLEMENT_CANCELLED", + "ENTITLEMENT_PENDING_PLAN_CHANGE", + "ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL", + "ENTITLEMENT_SUSPENDED" + ], + "enumDescriptions": [ + "Default state of the entitlement. It's only set to this value when the entitlement is first created and has not been initialized.", + "Indicates that the entitlement is being created and the backend has sent a notification to the provider for the activation approval. If the provider approves, then the entitlement will transition to the EntitlementState.ENTITLEMENT_ACTIVE state. Otherwise, the entitlement will be removed. Plan changes are not allowed in this state. Instead the entitlement is cancelled and re-created with a new plan name.", + "Indicates that the entitlement is active. The procured item is now usable and any associated billing events will start occurring. In this state, the customer can decide to cancel the entitlement, which would change the state to EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then EntitlementState.ENTITLEMENT_CANCELLED. The user can also request a change of plan, which will transition the state to EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to EntitlementState.ENTITLEMENT_ACTIVE.", + "Indicates that the entitlement was cancelled by the customer. The entitlement typically stays in this state if the entitlement/plan allows use of the underlying resource until the end of the current billing cycle. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot be modified during this state.", + "Indicates that the entitlement was cancelled. The entitlement can now be deleted.", + "Indicates that the entitlement is currently active, but there is a pending plan change that is requested by the customer. The entitlement typically stays in this state, if the entitlement/plan requires the completion of the current billing cycle before the plan can be changed. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_ACTIVE, with its plan changed.", + "Indicates that the entitlement is currently active, but there is a plan change request pending provider approval. If the provider approves the plan change, then the entitlement will transition either to EntitlementState.ENTITLEMENT_ACTIVE or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE depending on whether current plan requires that the billing cycle completes. If the provider rejects the plan change, then the pending plan change request is removed and the entitlement stays in EntitlementState.ENTITLEMENT_ACTIVE state with the old plan.", + "Indicates that the entitlement is suspended either by Google or provider request. This can be triggered for various external reasons (e.g. expiration of credit card on the billing account, violation of terms-of-service of the provider etc.). As such, any remediating action needs to be taken externally, before the entitlement can be activated. This is not yet supported." + ], + "type": "string" + }, + "subscriptionEndTime": { + "description": "Output only. End time for the subscription corresponding to this entitlement.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update timestamp.", + "format": "google-datetime", + "type": "string" + }, + "usageReportingId": { + "description": "Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountsResponse": { + "description": "Response message for [PartnerProcurementService.ListAccounts[].", + "id": "ListAccountsResponse", + "properties": { + "accounts": { + "description": "The list of accounts in this response.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token for fetching the next page.", + "type": "string" + } + }, + "type": "object" + }, + "ListEntitlementsResponse": { + "description": "Response message for PartnerProcurementService.ListEntitlements.", + "id": "ListEntitlementsResponse", + "properties": { + "entitlements": { + "description": "The list of entitlements in this response.", + "items": { + "$ref": "Entitlement" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token for fetching the next page.", + "type": "string" + } + }, + "type": "object" + }, + "RejectAccountRequest": { + "description": "Request message for PartnerProcurementService.RejectAccount.", + "id": "RejectAccountRequest", + "properties": { + "approvalName": { + "description": "The name of the approval being rejected. If absent and there is only one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", + "type": "string" + }, + "reason": { + "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "RejectEntitlementPlanChangeRequest": { + "description": "Request message for PartnerProcurementService.RejectEntitlementPlanChange.", + "id": "RejectEntitlementPlanChangeRequest", + "properties": { + "pendingPlanName": { + "description": "Name of the pending plan that is being rejected. Required.", + "type": "string" + }, + "reason": { + "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "RejectEntitlementRequest": { + "description": "Request message for PartnerProcurementService.RejectEntitlement.", + "id": "RejectEntitlementRequest", + "properties": { + "reason": { + "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", + "type": "string" + } + }, + "type": "object" + }, + "ResetAccountRequest": { + "description": "Request message for for PartnerProcurementService.ResetAccount.", + "id": "ResetAccountRequest", + "properties": {}, + "type": "object" + }, + "SuspendEntitlementRequest": { + "description": "Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported.", + "id": "SuspendEntitlementRequest", + "properties": { + "reason": { + "description": "A free-form reason string, explaining the reason for suspension request.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Commerce Partner Procurement API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json index 40711c48927..2ce713eff78 100644 --- a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json +++ b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json @@ -448,7 +448,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "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 17fd2490230..4059270b8e4 100644 --- a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json @@ -430,7 +430,7 @@ } } }, - "revision": "20210331", + "revision": "20210420", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index 89d9c85b6f0..7ba885493f5 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -197,7 +197,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -546,7 +546,7 @@ } } }, - "revision": "20210325", + "revision": "20210415", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1077,6 +1077,10 @@ "description": "The Cloud Build ID of the function created or updated by an API call. This field is only populated for Create and Update operations.", "type": "string" }, + "buildName": { + "description": "The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations. projects//locations//builds/.", + "type": "string" + }, "request": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", diff --git a/googleapiclient/discovery_cache/documents/cloudiot.v1.json b/googleapiclient/discovery_cache/documents/cloudiot.v1.json index 1d2524fae19..a5b45eb69ba 100644 --- a/googleapiclient/discovery_cache/documents/cloudiot.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudiot.v1.json @@ -938,7 +938,7 @@ } } }, - "revision": "20210330", + "revision": "20210413", "rootUrl": "https://cloudiot.googleapis.com/", "schemas": { "BindDeviceToGatewayRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 031015615d5..f6135c77a86 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -160,7 +160,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1259,7 +1259,7 @@ } } }, - "revision": "20210331", + "revision": "20210410", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -1666,7 +1666,7 @@ "This version is still being generated. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version may be used for cryptographic operations.", "This version may not be used, but the key material is still available, and the version can be placed back into the ENABLED state.", - "This version is destroyed, and the key material is no longer stored. A version may not leave this state once entered.", + "This version is destroyed, and the key material is no longer stored.", "This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state.", "This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason." diff --git a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json index c782aa95e74..152b3921ce7 100644 --- a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json @@ -216,7 +216,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "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 bd7f8ff2790..9b7dda2da97 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -1171,7 +1171,7 @@ } } }, - "revision": "20210409", + "revision": "20210425", "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 a0fc8f0a351..46aa3fc7315 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20210409", + "revision": "20210425", "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 97cbf3c67a0..f76f71e3a5a 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20210409", + "revision": "20210425", "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 1b1b974421e..c750eed542f 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20210409", + "revision": "20210425", "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 493b6621e17..bdea761e803 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -1612,7 +1612,7 @@ } } }, - "revision": "20210409", + "revision": "20210425", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json index 83ff8906e3d..31e07eb7e2d 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -418,7 +418,7 @@ } } }, - "revision": "20210315", + "revision": "20210420", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json index aa7f8335fd1..23cf8274987 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -428,7 +428,7 @@ } } }, - "revision": "20210315", + "revision": "20210420", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json index 1118ad15746..b55e56c4c18 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -1916,9 +1916,32 @@ } } }, - "revision": "20210322", + "revision": "20210406", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { + "AuditLoggingSettings": { + "description": "Represents the settings for Cloud audit logging", + "id": "AuditLoggingSettings", + "properties": { + "logAdminReadActions": { + "description": "Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc.", + "type": "boolean" + }, + "logDataReadActions": { + "description": "Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc.", + "type": "boolean" + }, + "logDataWriteActions": { + "description": "Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc.", + "type": "boolean" + }, + "project": { + "description": "The resource name of the GCP Project to store audit logs. Cloud audit logging will be enabled after project_name has been updated through CustomerService. Format: projects/{project_id}", + "type": "string" + } + }, + "type": "object" + }, "BooleanOperatorOptions": { "description": "Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", "id": "BooleanOperatorOptions", @@ -1978,6 +2001,24 @@ }, "type": "object" }, + "ContextAttribute": { + "description": "A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.", + "id": "ContextAttribute", + "properties": { + "name": { + "description": "The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.", + "type": "string" + }, + "values": { + "description": "Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CustomerIndexStats": { "description": "Aggregation of items by status code as of the specified date.", "id": "CustomerIndexStats", @@ -2031,6 +2072,10 @@ "description": "Represents settings at a customer level.", "id": "CustomerSettings", "properties": { + "auditLoggingSettings": { + "$ref": "AuditLoggingSettings", + "description": "Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." + }, "vpcSettings": { "$ref": "VPCSettings", "description": "VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." @@ -3119,6 +3164,13 @@ "description": "The BCP-47 language code for the item, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.", "type": "string" }, + "contextAttributes": { + "description": "A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.", + "items": { + "$ref": "ContextAttribute" + }, + "type": "array" + }, "createTime": { "description": "The time when the item was created in the source repository.", "format": "google-datetime", @@ -4367,6 +4419,10 @@ "description": "Display name of the Search Application. The maximum length is 300 characters.", "type": "string" }, + "enableAuditLog": { + "description": "Indicates whether audit logging is on/off for requests made for the search application in query APIs.", + "type": "boolean" + }, "name": { "description": "Name of the Search Application. Format: searchapplications/{application_id}.", "type": "string" @@ -4499,6 +4555,13 @@ "description": "The search API request.", "id": "SearchRequest", "properties": { + "contextAttributes": { + "description": "Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.", + "items": { + "$ref": "ContextAttribute" + }, + "type": "array" + }, "dataSourceRestrictions": { "description": "The sources to use for querying. If not specified, all data sources from the current search application are used.", "items": { diff --git a/googleapiclient/discovery_cache/documents/cloudshell.v1.json b/googleapiclient/discovery_cache/documents/cloudshell.v1.json index 9a136ec22e9..e746e68da6c 100644 --- a/googleapiclient/discovery_cache/documents/cloudshell.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudshell.v1.json @@ -374,7 +374,7 @@ } } }, - "revision": "20210405", + "revision": "20210426", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json index f48bd456716..aa04501a989 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json @@ -257,7 +257,7 @@ } } }, - "revision": "20210405", + "revision": "20210416", "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 1ff69dff06b..8ba90362f85 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json @@ -181,7 +181,7 @@ } } }, - "revision": "20210405", + "revision": "20210416", "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 e0ffddcc00a..d4caf799f2f 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json @@ -273,7 +273,7 @@ } } }, - "revision": "20210405", + "revision": "20210416", "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 71c80cf9307..d5f05d18b90 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -406,7 +406,7 @@ } } }, - "revision": "20210407", + "revision": "20210421", "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 5e60c440574..6e0a50039d7 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -434,7 +434,7 @@ } } }, - "revision": "20210407", + "revision": "20210421", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { @@ -492,7 +492,7 @@ "type": "object" }, "EncryptionConfig": { - "description": "The encryption options for the Composer environment and its dependencies.", + "description": "The encryption options for the Cloud Composer environment and its dependencies.", "id": "EncryptionConfig", "properties": { "kmsKeyName": { @@ -581,7 +581,7 @@ }, "encryptionConfig": { "$ref": "EncryptionConfig", - "description": "Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated." + "description": "Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated." }, "gkeCluster": { "description": "Output only. The Kubernetes Engine cluster used to run this environment.", @@ -794,7 +794,7 @@ "type": "array" }, "serviceAccount": { - "description": "Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the \"default\" Compute Engine service account is used. Cannot be updated.", + "description": "Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the \"default\" Compute Engine service account is used. Cannot be updated .", "type": "string" }, "subnetwork": { @@ -936,7 +936,7 @@ "type": "string" }, "enablePrivateEnvironment": { - "description": "Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true.", + "description": "Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true .", "type": "boolean" }, "privateClusterConfig": { diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index dd36af8306a..5883cc67ceb 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -2459,7 +2459,7 @@ } } }, - "revision": "20210325", + "revision": "20210413", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2785,6 +2785,11 @@ "description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, + "id": { + "description": "Output only. Unique id for the cluster.", + "readOnly": true, + "type": "string" + }, "initialClusterVersion": { "description": "The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"\",\"-\": picks the default Kubernetes version", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 7ca439e2485..628074f46a8 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -2484,7 +2484,7 @@ } } }, - "revision": "20210325", + "revision": "20210413", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2499,6 +2499,10 @@ "acceleratorType": { "description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)", "type": "string" + }, + "gpuPartitionSize": { + "description": "Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).", + "type": "string" } }, "type": "object" @@ -2837,6 +2841,11 @@ "description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, + "id": { + "description": "Output only. Unique id for the cluster.", + "readOnly": true, + "type": "string" + }, "initialClusterVersion": { "description": "The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"\",\"-\": picks the default Kubernetes version", "type": "string" @@ -3021,6 +3030,10 @@ "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." }, + "workloadCertificates": { + "$ref": "WorkloadCertificates", + "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods." + }, "workloadIdentityConfig": { "$ref": "WorkloadIdentityConfig", "description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies." @@ -3239,6 +3252,10 @@ "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." }, + "desiredWorkloadCertificates": { + "$ref": "WorkloadCertificates", + "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods." + }, "desiredWorkloadIdentityConfig": { "$ref": "WorkloadIdentityConfig", "description": "Configuration for Workload Identity." @@ -4096,7 +4113,7 @@ "type": "object" }, "NetworkTags": { - "description": "Collection of Compute Engine network tags that can be applied to a node's underyling VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)).", + "description": "Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)).", "id": "NetworkTags", "properties": { "tags": { @@ -5810,6 +5827,17 @@ }, "type": "object" }, + "WorkloadCertificates": { + "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", + "id": "WorkloadCertificates", + "properties": { + "enableCertificates": { + "description": "enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).", + "type": "boolean" + } + }, + "type": "object" + }, "WorkloadIdentityConfig": { "description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.", "id": "WorkloadIdentityConfig", diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 4b642f82bc4..637f6aec081 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -1217,7 +1217,7 @@ } } }, - "revision": "20210318", + "revision": "20210416", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "Artifact": { @@ -1639,6 +1639,10 @@ "source": { "description": "The source from which the information in this Detail was obtained.", "type": "string" + }, + "vendor": { + "description": "The vendor of the product. e.g. \"google\"", + "type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 30dbca607f4..aa7a222befb 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -853,7 +853,7 @@ } } }, - "revision": "20210318", + "revision": "20210416", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -1516,6 +1516,10 @@ "description": "The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.", "format": "google-datetime", "type": "string" + }, + "vendor": { + "description": "The name of the vendor of the product.", + "type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/content.v2.json b/googleapiclient/discovery_cache/documents/content.v2.json index fb3bc8bf8c7..e79f72cf466 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.json +++ b/googleapiclient/discovery_cache/documents/content.v2.json @@ -3298,7 +3298,7 @@ } } }, - "revision": "20210408", + "revision": "20210424", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -4269,12 +4269,19 @@ "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.", "type": "string" }, + "eddServices": { + "description": "A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService.", + "items": { + "type": "string" + }, + "type": "array" + }, "name": { "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.", "type": "string" }, "services": { - "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service.", + "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService.", "items": { "type": "string" }, @@ -4872,6 +4879,13 @@ "transitTimeTable": { "$ref": "TransitTable", "description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both." + }, + "warehouseBasedDeliveryTimes": { + "description": "Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set.", + "items": { + "$ref": "WarehouseBasedDeliveryTime" + }, + "type": "array" } }, "type": "object" @@ -10257,6 +10271,40 @@ }, "type": "object" }, + "WarehouseBasedDeliveryTime": { + "id": "WarehouseBasedDeliveryTime", + "properties": { + "carrier": { + "description": "Required. Carrier, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.", + "type": "string" + }, + "carrierService": { + "description": "Required. Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.", + "type": "string" + }, + "originAdministrativeArea": { + "description": "Required. Shipping origin's state.", + "type": "string" + }, + "originCity": { + "description": "Required. Shipping origin's city.", + "type": "string" + }, + "originCountry": { + "description": "Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).", + "type": "string" + }, + "originPostalCode": { + "description": "Required. Shipping origin.", + "type": "string" + }, + "originStreetAddress": { + "description": "Shipping origin's street address", + "type": "string" + } + }, + "type": "object" + }, "Weight": { "id": "Weight", "properties": { diff --git a/googleapiclient/discovery_cache/documents/content.v21.json b/googleapiclient/discovery_cache/documents/content.v21.json index 2fde7efa142..b52265d119c 100644 --- a/googleapiclient/discovery_cache/documents/content.v21.json +++ b/googleapiclient/discovery_cache/documents/content.v21.json @@ -5403,7 +5403,7 @@ } } }, - "revision": "20210408", + "revision": "20210424", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -6123,15 +6123,19 @@ "type": "string" }, "linkType": { - "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ", + "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" - \"`paymentServiceProvider`\" ", "type": "string" }, "linkedAccountId": { "description": "The ID of the linked account.", "type": "string" }, + "paymentServiceProviderLinkInfo": { + "$ref": "PaymentServiceProviderLinkInfo", + "description": "Additional information required for `paymentServiceProvider` link type." + }, "services": { - "description": " Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" ", + "description": " Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" - \"`paymentProcessing`\" ", "items": { "type": "string" }, @@ -6533,12 +6537,19 @@ "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.", "type": "string" }, + "eddServices": { + "description": "A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService.", + "items": { + "type": "string" + }, + "type": "array" + }, "name": { "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.", "type": "string" }, "services": { - "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service.", + "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService.", "items": { "type": "string" }, @@ -7394,6 +7405,13 @@ "transitTimeTable": { "$ref": "TransitTable", "description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both." + }, + "warehouseBasedDeliveryTimes": { + "description": "Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set.", + "items": { + "$ref": "WarehouseBasedDeliveryTime" + }, + "type": "array" } }, "type": "object" @@ -7599,7 +7617,9 @@ "TRIUMPHED_OVER_BY_SAME_TYPE_RULE", "TRIUMPHED_OVER_BY_OTHER_RULE_ON_OFFER", "RESTRICTIONS_NOT_MET", - "UNCATEGORIZED" + "UNCATEGORIZED", + "INVALID_AUTO_PRICE_MIN", + "INVALID_FLOOR_CONFIG" ], "enumDescriptions": [ "Default value. Should not be used.", @@ -7608,7 +7628,9 @@ "Another rule of the same type takes precedence over this one.", "Another rule of a different type takes precedence over this one.", "The rule restrictions are not met. For example, this may be the case if the calculated rule price is lower than floor price in the restriction.", - "The reason is not categorized to any known reason." + "The reason is not categorized to any known reason.", + "The auto_pricing_min_price is invalid. For example, it is missing or < 0.", + "The floor defined in the rule is invalid. For example, it has the wrong sign which results in a floor < 0." ], "type": "string" } @@ -8019,7 +8041,7 @@ "id": "LinkService", "properties": { "service": { - "description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" ", + "description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" - \"`paymentProcessing`\" ", "type": "string" }, "status": { @@ -10762,6 +10784,21 @@ "properties": {}, "type": "object" }, + "PaymentServiceProviderLinkInfo": { + "description": "Additional information required for PAYMENT_SERVICE_PROVIDER link type.", + "id": "PaymentServiceProviderLinkInfo", + "properties": { + "externalAccountBusinessCountry": { + "description": "The business country of the merchant account as identified by the third party service provider.", + "type": "string" + }, + "externalAccountId": { + "description": "The id used by the third party service provider to identify the merchant.", + "type": "string" + } + }, + "type": "object" + }, "PickupCarrierService": { "id": "PickupCarrierService", "properties": { @@ -14493,6 +14530,40 @@ }, "type": "object" }, + "WarehouseBasedDeliveryTime": { + "id": "WarehouseBasedDeliveryTime", + "properties": { + "carrier": { + "description": "Required. Carrier, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.", + "type": "string" + }, + "carrierService": { + "description": "Required. Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.", + "type": "string" + }, + "originAdministrativeArea": { + "description": "Required. Shipping origin's state.", + "type": "string" + }, + "originCity": { + "description": "Required. Shipping origin's city.", + "type": "string" + }, + "originCountry": { + "description": "Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).", + "type": "string" + }, + "originPostalCode": { + "description": "Required. Shipping origin.", + "type": "string" + }, + "originStreetAddress": { + "description": "Shipping origin's street address.", + "type": "string" + } + }, + "type": "object" + }, "Weight": { "id": "Weight", "properties": { diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index 87db07ab92e..ea40bda7f1f 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -674,7 +674,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json index 0fe1f6a0a7f..535ca02e412 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json @@ -1808,7 +1808,7 @@ } } }, - "revision": "20210402", + "revision": "20210412", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index 842e482aed5..ef6bbfe31d6 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -12,7 +12,7 @@ "description": "View your Google Compute Engine resources" }, "https://www.googleapis.com/auth/userinfo.email": { - "description": "View your email address" + "description": "See your primary Google Account email address" } } } @@ -2225,7 +2225,7 @@ } } }, - "revision": "20210324", + "revision": "20210420", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3372,6 +3372,10 @@ "description": "The email address of the service account to run the job as.", "type": "string" }, + "stagingLocation": { + "description": "The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`.", + "type": "string" + }, "subnetwork": { "description": "Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form \"https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK\" or \"regions/REGION/subnetworks/SUBNETWORK\". If the subnetwork is located in a Shared VPC network, you must use the complete URL.", "type": "string" @@ -4599,6 +4603,13 @@ "description": "Metadata for a specific parameter.", "id": "ParameterMetadata", "properties": { + "customMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Additional metadata for describing this parameter.", + "type": "object" + }, "helpText": { "description": "Required. The help text to display for the parameter.", "type": "string" @@ -5401,6 +5412,10 @@ }, "type": "array" }, + "region": { + "description": "Cloud region where this snapshot lives in, e.g., \"us-central1\".", + "type": "string" + }, "sourceJobId": { "description": "The job this snapshot was created from.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json b/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json index cffb5d0376b..7b47e435150 100644 --- a/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json @@ -1,5658 +1,5658 @@ { - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "See, edit, configure, and delete your Google Cloud Platform data" - } - } + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud Platform data" } + } + } + }, + "basePath": "", + "baseUrl": "https://datalabeling.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Data Labeling", + "description": "Public API for Google Cloud AI Data Labeling Service.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/data-labeling/docs/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "datalabeling:v1beta1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://datalabeling.mtls.googleapis.com/", + "name": "datalabeling", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" }, - "basePath": "", - "baseUrl": "https://datalabeling.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Data Labeling", - "description": "Public API for Google Cloud AI Data Labeling Service.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/data-labeling/docs/", - "fullyEncodeReservedExpansion": true, - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "datalabeling:v1beta1", - "kind": "discovery#restDescription", - "mtlsRootUrl": "https://datalabeling.mtls.googleapis.com/", - "name": "datalabeling", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "description": "Data format for response.", - "enum": [ - "json", - "media", - "proto" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "location": "query", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", - "location": "query", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "annotationSpecSets": { - "methods": { - "create": { - "description": "Creates an annotation spec set by providing a set of labels.", - "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", - "httpMethod": "POST", - "id": "datalabeling.projects.annotationSpecSets.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. AnnotationSpecSet resource parent, format: projects/{project_id}", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/annotationSpecSets", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest" - }, - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an annotation spec set by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.annotationSpecSets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.", - "location": "path", - "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an annotation spec set by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.annotationSpecSets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", - "location": "path", - "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists annotation spec sets for a project. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", - "httpMethod": "GET", - "id": "datalabeling.projects.annotationSpecSets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter is not supported at this moment.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotationSpecSetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotationSpecSets] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/annotationSpecSets", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "annotationSpecSets": { + "methods": { + "create": { + "description": "Creates an annotation spec set by providing a set of labels.", + "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", + "httpMethod": "POST", + "id": "datalabeling.projects.annotationSpecSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. AnnotationSpecSet resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/annotationSpecSets", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an annotation spec set by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.annotationSpecSets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an annotation spec set by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.annotationSpecSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", + "location": "path", + "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists annotation spec sets for a project. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/annotationSpecSets", + "httpMethod": "GET", + "id": "datalabeling.projects.annotationSpecSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" }, - "datasets": { - "methods": { - "create": { - "description": "Creates dataset. If success return a Dataset resource.", - "flatPath": "v1beta1/projects/{projectsId}/datasets", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Dataset resource parent, format: projects/{project_id}", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/datasets", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest" - }, - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a dataset by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.datasets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "exportData": { - "description": "Exports data and annotations from dataset.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:exportData", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.exportData", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:exportData", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1ExportDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets dataset by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "importData": { - "description": "Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:importData", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.importData", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:importData", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1ImportDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists datasets under a project. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/datasets", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter on dataset is not supported at this moment.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDatasetsResponse.next_page_token of the previous [DataLabelingService.ListDatasets] call. Returns the first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Dataset resource parent, format: projects/{project_id}", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/datasets", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotationSpecSetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotationSpecSets] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/annotationSpecSets", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "datasets": { + "methods": { + "create": { + "description": "Creates dataset. If success return a Dataset resource.", + "flatPath": "v1beta1/projects/{projectsId}/datasets", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Dataset resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasets", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a dataset by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "exportData": { + "description": "Exports data and annotations from dataset.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:exportData", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.exportData", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:exportData", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1ExportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets dataset by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "importData": { + "description": "Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}:importData", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.importData", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:importData", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1ImportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists datasets under a project. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/datasets", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter on dataset is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDatasetsResponse.next_page_token of the previous [DataLabelingService.ListDatasets] call. Returns the first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Dataset resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasets", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "annotatedDatasets": { + "methods": { + "delete": { + "description": "Deletes an annotated dataset by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.annotatedDatasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an annotated dataset by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists annotated datasets for a dataset. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotatedDatasetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotatedDatasets] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/annotatedDatasets", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "dataItems": { + "methods": { + "get": { + "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems/{dataItemsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1DataItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "resources": { - "annotatedDatasets": { - "methods": { - "delete": { - "description": "Deletes an annotated dataset by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.datasets.annotatedDatasets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an annotated dataset by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists annotated datasets for a dataset. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter is not supported at this moment.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotatedDatasetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotatedDatasets] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/annotatedDatasets", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "dataItems": { - "methods": { - "get": { - "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems/{dataItemsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/dataItems/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1DataItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter is not supported at this moment.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/dataItems", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "examples": { - "methods": { - "get": { - "description": "Gets an example by resource name, including both data and annotation.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples/{examplesId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.examples.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/examples/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1Example" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists examples in an annotated dataset. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.examples.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Example resource parent.", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/examples", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListExamplesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "feedbackThreads": { - "methods": { - "delete": { - "description": "Delete a FeedbackThread.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the FeedbackThread that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Get a FeedbackThread object.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "List FeedbackThreads with pagination.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackThreads.next_page_token of the previous [DataLabelingService.ListFeedbackThreads] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. FeedbackThread resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/feedbackThreads", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "feedbackMessages": { - "methods": { - "create": { - "description": "Create a FeedbackMessage object.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/feedbackMessages", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Delete a FeedbackMessage.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the FeedbackMessage that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Get a FeedbackMessage object.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "List FeedbackMessages with pagination.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackMessages.next_page_token of the previous [DataLabelingService.ListFeedbackMessages] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. FeedbackMessage resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/feedbackMessages", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - }, - "dataItems": { - "methods": { - "get": { - "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems/{dataItemsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.dataItems.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/dataItems/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1DataItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.dataItems.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter is not supported at this moment.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/dataItems", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "evaluations": { - "methods": { - "get": { - "description": "Gets an evaluation by resource name (to search, use projects.evaluations.search).", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.datasets.evaluations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the evaluation. Format: \"projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "exampleComparisons": { - "methods": { - "search": { - "description": "Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}/exampleComparisons:search", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.evaluations.exampleComparisons.search", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Name of the Evaluation resource to search for example comparisons from. Format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/exampleComparisons:search", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest" - }, - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } + "list": { + "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" }, - "image": { - "methods": { - "label": { - "description": "Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.image.label", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/image:label", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelImageRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "text": { - "methods": { - "label": { - "description": "Starts a labeling task for text. The type of text labeling task is configured by feature in the request.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/text:label", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.text.label", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/text:label", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelTextRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.", + "location": "query", + "type": "string" }, - "video": { - "methods": { - "label": { - "description": "Starts a labeling task for video. The type of video labeling task is configured by feature in the request.", - "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/video:label", - "httpMethod": "POST", - "id": "datalabeling.projects.datasets.video.label", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", - "location": "path", - "pattern": "^projects/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/video:label", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "parent": { + "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" } + }, + "path": "v1beta1/{+parent}/dataItems", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } + } }, - "evaluationJobs": { - "methods": { - "create": { - "description": "Creates an evaluation job.", - "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", - "httpMethod": "POST", - "id": "datalabeling.projects.evaluationJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationJobs", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest" - }, - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Stops and deletes an evaluation job.", - "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.evaluationJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the evaluation job that is going to be deleted. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an evaluation job by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.evaluationJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the evaluation job. Format: \"projects/{project_id} /evaluationJobs/{evaluation_job_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "examples": { + "methods": { + "get": { + "description": "Gets an example by resource name, including both data and annotation.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples/{examplesId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.examples.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists all evaluation jobs within a project with possible filters. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", - "httpMethod": "GET", - "id": "datalabeling.projects.evaluationJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the `AND` operator or the `OR` operator. For example, you can use the following string for your filter: \"evaluation_job.model_id = {model_name} AND evaluation_job.state = {evaluation_job_state}\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationJobs", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/examples/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Example" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists examples in an annotated dataset. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.examples.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"", + "location": "query", + "type": "string" }, - "patch": { - "description": "Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: `humanAnnotationConfig.instruction`, `exampleCount`, and `exampleSamplePercentage`. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.", - "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", - "httpMethod": "PATCH", - "id": "datalabeling.projects.evaluationJobs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Mask for which fields to update. You can only provide the following fields: * `evaluationJobConfig.humanAnnotationConfig.instruction` * `evaluationJobConfig.exampleCount` * `evaluationJobConfig.exampleSamplePercentage` You can provide more than one of these fields by separating them with commas.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" - }, - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "pause": { - "description": "Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.", - "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:pause", - "httpMethod": "POST", - "id": "datalabeling.projects.evaluationJobs.pause", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the evaluation job that is going to be paused. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:pause", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.", + "location": "query", + "type": "string" }, - "resume": { - "description": "Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.", - "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:resume", - "httpMethod": "POST", - "id": "datalabeling.projects.evaluationJobs.resume", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the evaluation job that is going to be resumed. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", - "location": "path", - "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:resume", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "parent": { + "description": "Required. Example resource parent.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" } + }, + "path": "v1beta1/{+parent}/examples", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } + } }, - "evaluations": { - "methods": { - "search": { - "description": "Searches evaluations within a project.", - "flatPath": "v1beta1/projects/{projectsId}/evaluations:search", - "httpMethod": "GET", - "id": "datalabeling.projects.evaluations.search", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. To search evaluations, you can filter by the following: * evaluation_job.evaluation_job_id (the last part of EvaluationJob.name) * evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion) * evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.job_state (EvaluationJob.state) * annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName) To filter by multiple critiera, use the `AND` operator or the `OR` operator. The following examples shows a string that filters by several critiera: \"evaluation_job.evaluation_job_id = {evaluation_job_id} AND evaluation_job.model_id = {model_name} AND evaluation_job.evaluation_job_run_time_start = {timestamp_1} AND evaluation_job.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request. If you don't specify this field, the API call requests the first page of the search.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Evaluation search parent (project ID). Format: \"projects/ {project_id}\"", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluations:search", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "feedbackThreads": { + "methods": { + "delete": { + "description": "Delete a FeedbackThread.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the FeedbackThread that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" } - } - }, - "instructions": { - "methods": { - "create": { - "description": "Creates an instruction for how data should be labeled.", - "flatPath": "v1beta1/projects/{projectsId}/instructions", - "httpMethod": "POST", - "id": "datalabeling.projects.instructions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Instruction resource parent, format: projects/{project_id}", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/instructions", - "request": { - "$ref": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an instruction object by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.instructions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", - "location": "path", - "pattern": "^projects/[^/]+/instructions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a FeedbackThread object.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List FeedbackThreads with pagination.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets an instruction by resource name.", - "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.instructions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", - "location": "path", - "pattern": "^projects/[^/]+/instructions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1Instruction" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackThreads.next_page_token of the previous [DataLabelingService.ListFeedbackThreads] call. Return first page if empty.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists instructions for a project. Pagination is supported.", - "flatPath": "v1beta1/projects/{projectsId}/instructions", - "httpMethod": "GET", - "id": "datalabeling.projects.instructions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter is not supported at this moment.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous [DataLabelingService.ListInstructions] call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Instruction resource parent, format: projects/{project_id}", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/instructions", - "response": { - "$ref": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "parent": { + "description": "Required. FeedbackThread resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" } + }, + "path": "v1beta1/{+parent}/feedbackThreads", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel", - "httpMethod": "GET", - "id": "datalabeling.projects.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + }, + "resources": { + "feedbackMessages": { + "methods": { + "create": { + "description": "Create a FeedbackMessage object.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/feedbackMessages", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "datalabeling.projects.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "description": "Delete a FeedbackMessage.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the FeedbackMessage that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "datalabeling.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "description": "Get a FeedbackMessage object.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "flatPath": "v1beta1/projects/{projectsId}/operations", - "httpMethod": "GET", - "id": "datalabeling.projects.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } + "description": "List FeedbackMessages with pagination.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackMessages.next_page_token of the previous [DataLabelingService.ListFeedbackMessages] call. Return first page if empty.", + "location": "query", + "type": "string" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "parent": { + "description": "Required. FeedbackMessage resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/feedbackMessages", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } + } } - } - } - } - }, - "revision": "20210324", - "rootUrl": "https://datalabeling.googleapis.com/", - "schemas": { - "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { - "description": "Metadata of a CreateInstruction operation.", - "id": "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata", - "properties": { - "createTime": { - "description": "Timestamp when create instruction request was created.", - "format": "google-datetime", - "type": "string" - }, - "instruction": { - "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", - "type": "string" - }, - "partialFailures": { - "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" + } + } + } + }, + "dataItems": { + "methods": { + "get": { + "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems/{dataItemsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.dataItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1DataItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.dataItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata": { - "description": "Metadata of an ExportData operation.", - "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when export dataset request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", - "type": "string" - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse": { - "description": "Response used for ExportDataset longrunning operation.", - "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "dataset": { - "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", - "type": "string" - }, - "exportCount": { - "description": "Output only. Number of examples exported successfully.", - "format": "int32", - "type": "integer" - }, - "labelStats": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelStats", - "description": "Output only. Statistic infos of labels in the exported dataset." - }, - "outputConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1OutputConfig", - "description": "Output only. output_config in the ExportData request." - }, - "totalCount": { - "description": "Output only. Total number of examples requested to export", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1GcsDestination": { - "description": "Export destination of the data.Only gcs path is allowed in output_uri.", - "id": "GoogleCloudDatalabelingV1alpha1GcsDestination", - "properties": { - "mimeType": { - "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", - "type": "string" - }, - "outputUri": { - "description": "Required. The output uri of destination file.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1GcsFolderDestination": { - "description": "Export folder destination of the data.", - "id": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", - "properties": { - "outputFolderUri": { - "description": "Required. Cloud Storage directory to export data to.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig": { - "description": "Configuration for how human labeling task should be done.", - "id": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "properties": { - "annotatedDatasetDescription": { - "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", - "type": "string" - }, - "annotatedDatasetDisplayName": { - "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", - "type": "string" - }, - "contributorEmails": { - "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", - "items": { - "type": "string" + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.", + "location": "query", + "type": "string" }, - "type": "array" - }, - "instruction": { - "description": "Required. Instruction resource name.", - "type": "string" + "parent": { + "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dataItems", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluations": { + "methods": { + "get": { + "description": "Gets an evaluation by resource name (to search, use projects.evaluations.search).", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation. Format: \"projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "exampleComparisons": { + "methods": { + "search": { + "description": "Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}/exampleComparisons:search", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.evaluations.exampleComparisons.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the Evaluation resource to search for example comparisons from. Format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/exampleComparisons:search", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "image": { + "methods": { + "label": { + "description": "Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.image.label", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/image:label", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "text": { + "methods": { + "label": { + "description": "Starts a labeling task for text. The type of text labeling task is configured by feature in the request.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/text:label", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.text.label", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/text:label", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelTextRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "video": { + "methods": { + "label": { + "description": "Starts a labeling task for video. The type of video labeling task is configured by feature in the request.", + "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/video:label", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.video.label", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/video:label", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationJobs": { + "methods": { + "create": { + "description": "Creates an evaluation job.", + "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", + "httpMethod": "POST", + "id": "datalabeling.projects.evaluationJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationJobs", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Stops and deletes an evaluation job.", + "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.evaluationJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job that is going to be deleted. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an evaluation job by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.evaluationJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job. Format: \"projects/{project_id} /evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all evaluation jobs within a project with possible filters. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", + "httpMethod": "GET", + "id": "datalabeling.projects.evaluationJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the `AND` operator or the `OR` operator. For example, you can use the following string for your filter: \"evaluation_job.model_id = {model_name} AND evaluation_job.state = {evaluation_job_state}\"", + "location": "query", + "type": "string" }, - "labelGroup": { - "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", - "type": "string" + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "languageCode": { - "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", - "type": "string" + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationJobs", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: `humanAnnotationConfig.instruction`, `exampleCount`, and `exampleSamplePercentage`. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.", + "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}", + "httpMethod": "PATCH", + "id": "datalabeling.projects.evaluationJobs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask for which fields to update. You can only provide the following fields: * `evaluationJobConfig.humanAnnotationConfig.instruction` * `evaluationJobConfig.exampleCount` * `evaluationJobConfig.exampleSamplePercentage` You can provide more than one of these fields by separating them with commas.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pause": { + "description": "Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.", + "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:pause", + "httpMethod": "POST", + "id": "datalabeling.projects.evaluationJobs.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job that is going to be paused. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:pause", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.", + "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:resume", + "httpMethod": "POST", + "id": "datalabeling.projects.evaluationJobs.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job that is going to be resumed. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:resume", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluations": { + "methods": { + "search": { + "description": "Searches evaluations within a project.", + "flatPath": "v1beta1/projects/{projectsId}/evaluations:search", + "httpMethod": "GET", + "id": "datalabeling.projects.evaluations.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. To search evaluations, you can filter by the following: * evaluation_job.evaluation_job_id (the last part of EvaluationJob.name) * evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion) * evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.job_state (EvaluationJob.state) * annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName) To filter by multiple critiera, use the `AND` operator or the `OR` operator. The following examples shows a string that filters by several critiera: \"evaluation_job.evaluation_job_id = {evaluation_job_id} AND evaluation_job.model_id = {model_name} AND evaluation_job.evaluation_job_run_time_start = {timestamp_1} AND evaluation_job.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}\"", + "location": "query", + "type": "string" }, - "questionDuration": { - "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", - "format": "google-duration", - "type": "string" + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "replicaCount": { - "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", - "format": "int32", - "type": "integer" + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request. If you don't specify this field, the API call requests the first page of the search.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Evaluation search parent (project ID). Format: \"projects/ {project_id}\"", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluations:search", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "instructions": { + "methods": { + "create": { + "description": "Creates an instruction for how data should be labeled.", + "flatPath": "v1beta1/projects/{projectsId}/instructions", + "httpMethod": "POST", + "id": "datalabeling.projects.instructions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Instruction resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/instructions", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an instruction object by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.instructions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", + "location": "path", + "pattern": "^projects/[^/]+/instructions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an instruction by resource name.", + "flatPath": "v1beta1/projects/{projectsId}/instructions/{instructionsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.instructions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", + "location": "path", + "pattern": "^projects/[^/]+/instructions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Instruction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists instructions for a project. Pagination is supported.", + "flatPath": "v1beta1/projects/{projectsId}/instructions", + "httpMethod": "GET", + "id": "datalabeling.projects.instructions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" }, - "userEmailAddress": { - "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata": { - "description": "Metadata of an ImportData operation.", - "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata", - "properties": { - "createTime": { - "description": "Output only. Timestamp when import dataset request was created.", - "format": "google-datetime", - "type": "string" + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" }, - "dataset": { - "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", - "type": "string" + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous [DataLabelingService.ListInstructions] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Instruction resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/instructions", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel", + "httpMethod": "GET", + "id": "datalabeling.projects.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "datalabeling.projects.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "datalabeling.projects.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "flatPath": "v1beta1/projects/{projectsId}/operations", + "httpMethod": "GET", + "id": "datalabeling.projects.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse": { - "description": "Response used for ImportData longrunning operation.", - "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse", - "properties": { - "dataset": { - "description": "Ouptut only. The name of imported dataset.", - "type": "string" + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" }, - "importCount": { - "description": "Output only. Number of examples imported successfully.", - "format": "int32", - "type": "integer" + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "totalCount": { - "description": "Output only. Total number of examples requested to import", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata": { - "description": "Details of LabelImageBoundingPoly operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata": { - "description": "Metadata of a LabelImageClassification operation.", - "id": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata": { - "description": "Details of LabelImagePolyline operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata": { - "description": "Details of a LabelImageSegmentation operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata": { - "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", - "id": "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when labeling request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", - "type": "string" - }, - "imageBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", - "description": "Details of label image bounding box operation." - }, - "imageBoundingPolyDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata", - "description": "Details of label image bounding poly operation." - }, - "imageClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", - "description": "Details of label image classification operation." - }, - "imageOrientedBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", - "description": "Details of label image oriented bounding box operation." - }, - "imagePolylineDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", - "description": "Details of label image polyline operation." - }, - "imageSegmentationDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", - "description": "Details of label image segmentation operation." - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "progressPercent": { - "description": "Output only. Progress of label operation. Range: [0, 100].", - "format": "int32", - "type": "integer" - }, - "textClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", - "description": "Details of label text classification operation." - }, - "textEntityExtractionDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", - "description": "Details of label text entity extraction operation." - }, - "videoClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", - "description": "Details of label video classification operation." - }, - "videoEventDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", - "description": "Details of label video event operation." - }, - "videoObjectDetectionDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", - "description": "Details of label video object detection operation." - }, - "videoObjectTrackingDetails": { - "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata", - "description": "Details of label video object tracking operation." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelStats": { - "description": "Statistics about annotation specs.", - "id": "GoogleCloudDatalabelingV1alpha1LabelStats", - "properties": { - "exampleCount": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata": { - "description": "Details of a LabelTextClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata": { - "description": "Details of a LabelTextEntityExtraction operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata": { - "description": "Details of a LabelVideoClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata": { - "description": "Details of a LabelVideoEvent operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata": { - "description": "Details of a LabelVideoObjectDetection operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata": { - "description": "Details of a LabelVideoObjectTracking operation metadata.", - "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1alpha1OutputConfig": { - "description": "The configuration of output data.", - "id": "GoogleCloudDatalabelingV1alpha1OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDatalabelingV1alpha1GcsDestination", - "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." - }, - "gcsFolderDestination": { - "$ref": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", - "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1AnnotatedDataset": { - "description": "AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.", - "id": "GoogleCloudDatalabelingV1beta1AnnotatedDataset", - "properties": { - "annotationSource": { - "description": "Output only. Source of the annotation.", - "enum": [ - "ANNOTATION_SOURCE_UNSPECIFIED", - "OPERATOR" - ], - "enumDescriptions": [ - "", - "Answer is provided by a human contributor." - ], - "type": "string" - }, - "annotationType": { - "description": "Output only. Type of the annotation. It is specified when starting labeling task.", - "enum": [ - "ANNOTATION_TYPE_UNSPECIFIED", - "IMAGE_CLASSIFICATION_ANNOTATION", - "IMAGE_BOUNDING_BOX_ANNOTATION", - "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", - "IMAGE_BOUNDING_POLY_ANNOTATION", - "IMAGE_POLYLINE_ANNOTATION", - "IMAGE_SEGMENTATION_ANNOTATION", - "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", - "VIDEO_OBJECT_TRACKING_ANNOTATION", - "VIDEO_OBJECT_DETECTION_ANNOTATION", - "VIDEO_EVENT_ANNOTATION", - "TEXT_CLASSIFICATION_ANNOTATION", - "TEXT_ENTITY_EXTRACTION_ANNOTATION", - "GENERAL_CLASSIFICATION_ANNOTATION" - ], - "enumDescriptions": [ - "", - "Classification annotations in an image. Allowed for continuous evaluation.", - "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", - "Oriented bounding box. The box does not have to be parallel to horizontal line.", - "Bounding poly annotations in an image.", - "Polyline annotations in an image.", - "Segmentation annotations in an image.", - "Classification annotations in video shots.", - "Video object tracking annotation.", - "Video object detection annotation.", - "Video event annotation.", - "Classification for text. Allowed for continuous evaluation.", - "Entity extraction for text.", - "General classification. Allowed for continuous evaluation." - ], - "type": "string" - }, - "blockingResources": { - "description": "Output only. The names of any related resources that are blocking changes to the annotated dataset.", - "items": { - "type": "string" - }, - "type": "array" - }, - "completedExampleCount": { - "description": "Output only. Number of examples that have annotation in the annotated dataset.", - "format": "int64", - "type": "string" - }, - "createTime": { - "description": "Output only. Time the AnnotatedDataset was created.", - "format": "google-datetime", - "type": "string" - }, - "description": { - "description": "Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.", - "type": "string" - }, - "displayName": { - "description": "Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.", - "type": "string" - }, - "exampleCount": { - "description": "Output only. Number of examples in the annotated dataset.", - "format": "int64", - "type": "string" - }, - "labelStats": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", - "description": "Output only. Per label statistics." - }, - "metadata": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata", - "description": "Output only. Additional information about AnnotatedDataset." - }, - "name": { - "description": "Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata": { - "description": "Metadata on AnnotatedDataset.", - "id": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata", - "properties": { - "boundingPolyConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", - "description": "Configuration for image bounding box and bounding poly task." - }, - "eventConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", - "description": "Configuration for video event labeling task." - }, - "humanAnnotationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "HumanAnnotationConfig used when requesting the human labeling task for this AnnotatedDataset." - }, - "imageClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", - "description": "Configuration for image classification task." - }, - "objectDetectionConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", - "description": "Configuration for video object detection task." - }, - "objectTrackingConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", - "description": "Configuration for video object tracking task." - }, - "polylineConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", - "description": "Configuration for image polyline task." - }, - "segmentationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", - "description": "Configuration for image segmentation task." - }, - "textClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", - "description": "Configuration for text classification task." - }, - "textEntityExtractionConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", - "description": "Configuration for text entity extraction task." - }, - "videoClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", - "description": "Configuration for video classification task." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Annotation": { - "description": "Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.", - "id": "GoogleCloudDatalabelingV1beta1Annotation", - "properties": { - "annotationMetadata": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationMetadata", - "description": "Output only. Annotation metadata, including information like votes for labels." - }, - "annotationSentiment": { - "description": "Output only. Sentiment for this annotation.", - "enum": [ - "ANNOTATION_SENTIMENT_UNSPECIFIED", - "NEGATIVE", - "POSITIVE" - ], - "enumDescriptions": [ - "", - "This annotation describes negatively about the data.", - "This label describes positively about the data." - ], - "type": "string" - }, - "annotationSource": { - "description": "Output only. The source of the annotation.", - "enum": [ - "ANNOTATION_SOURCE_UNSPECIFIED", - "OPERATOR" - ], - "enumDescriptions": [ - "", - "Answer is provided by a human contributor." - ], - "type": "string" - }, - "annotationValue": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationValue", - "description": "Output only. This is the actual annotation value, e.g classification, bounding box values are stored here." - }, - "name": { - "description": "Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1AnnotationMetadata": { - "description": "Additional information associated with the annotation.", - "id": "GoogleCloudDatalabelingV1beta1AnnotationMetadata", - "properties": { - "operatorMetadata": { - "$ref": "GoogleCloudDatalabelingV1beta1OperatorMetadata", - "description": "Metadata related to human labeling." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1AnnotationSpec": { - "description": "Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.", - "id": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "properties": { - "description": { - "description": "Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.", - "type": "string" - }, - "displayName": { - "description": "Required. The display name of the AnnotationSpec. Maximum of 64 characters.", - "type": "string" - }, - "index": { - "description": "Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: \"dog\", index: 0 }` and one AnnotationSpec with `{ display_name: \"cat\", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1AnnotationSpecSet": { - "description": "An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.", - "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", - "properties": { - "annotationSpecs": { - "description": "Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" - }, - "type": "array" - }, - "blockingResources": { - "description": "Output only. The names of any related resources that are blocking changes to the annotation spec set.", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.", - "type": "string" - }, - "displayName": { - "description": "Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.", - "type": "string" - }, - "name": { - "description": "Output only. The AnnotationSpecSet resource name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig": { - "description": "Annotation spec set with the setting of allowing multi labels or not.", - "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig", - "properties": { - "allowMultiLabel": { - "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set.", - "type": "boolean" - }, - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1AnnotationValue": { - "description": "Annotation value for an example.", - "id": "GoogleCloudDatalabelingV1beta1AnnotationValue", - "properties": { - "imageBoundingPolyAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", - "description": "Annotation value for image bounding box, oriented bounding box and polygon cases." - }, - "imageClassificationAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", - "description": "Annotation value for image classification case." - }, - "imagePolylineAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", - "description": "Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other." - }, - "imageSegmentationAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation", - "description": "Annotation value for image segmentation." - }, - "textClassificationAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", - "description": "Annotation value for text classification case." - }, - "textEntityExtractionAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", - "description": "Annotation value for text entity extraction case." - }, - "videoClassificationAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", - "description": "Annotation value for video classification case." - }, - "videoEventAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation", - "description": "Annotation value for video event case." - }, - "videoObjectTrackingAnnotation": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation", - "description": "Annotation value for video object detection and tracking case." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Attempt": { - "description": "Records a failed evaluation job run.", - "id": "GoogleCloudDatalabelingV1beta1Attempt", - "properties": { - "attemptTime": { - "format": "google-datetime", - "type": "string" - }, - "partialFailures": { - "description": "Details of errors that occurred.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1BigQuerySource": { - "description": "The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version.", - "id": "GoogleCloudDatalabelingV1beta1BigQuerySource", - "properties": { - "inputUri": { - "description": "Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: \"bq://{your_project_id}/ {your_dataset_name}/{your_table_name}\" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions": { - "description": "Options regarding evaluation between bounding boxes.", - "id": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", - "properties": { - "iouThreshold": { - "description": "Minimum [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) required for 2 bounding boxes to be considered a match. This must be a number between 0 and 1.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1BoundingPoly": { - "description": "A bounding polygon in the image.", - "id": "GoogleCloudDatalabelingV1beta1BoundingPoly", - "properties": { - "vertices": { - "description": "The bounding polygon vertices.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Vertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1BoundingPolyConfig": { - "description": "Config for image bounding poly (and bounding box) human labeling task.", - "id": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", - "properties": { - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - }, - "instructionMessage": { - "description": "Optional. Instruction message showed on contributors UI.", - "type": "string" - } - }, - "type": "object" + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20210420", + "rootUrl": "https://datalabeling.googleapis.com/", + "schemas": { + "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1alpha1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1alpha1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1alpha1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1alpha1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotatedDataset": { + "description": "AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.", + "id": "GoogleCloudDatalabelingV1beta1AnnotatedDataset", + "properties": { + "annotationSource": { + "description": "Output only. Source of the annotation.", + "enum": [ + "ANNOTATION_SOURCE_UNSPECIFIED", + "OPERATOR" + ], + "enumDescriptions": [ + "", + "Answer is provided by a human contributor." + ], + "type": "string" + }, + "annotationType": { + "description": "Output only. Type of the annotation. It is specified when starting labeling task.", + "enum": [ + "ANNOTATION_TYPE_UNSPECIFIED", + "IMAGE_CLASSIFICATION_ANNOTATION", + "IMAGE_BOUNDING_BOX_ANNOTATION", + "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", + "IMAGE_BOUNDING_POLY_ANNOTATION", + "IMAGE_POLYLINE_ANNOTATION", + "IMAGE_SEGMENTATION_ANNOTATION", + "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", + "VIDEO_OBJECT_TRACKING_ANNOTATION", + "VIDEO_OBJECT_DETECTION_ANNOTATION", + "VIDEO_EVENT_ANNOTATION", + "TEXT_CLASSIFICATION_ANNOTATION", + "TEXT_ENTITY_EXTRACTION_ANNOTATION", + "GENERAL_CLASSIFICATION_ANNOTATION" + ], + "enumDescriptions": [ + "", + "Classification annotations in an image. Allowed for continuous evaluation.", + "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", + "Oriented bounding box. The box does not have to be parallel to horizontal line.", + "Bounding poly annotations in an image.", + "Polyline annotations in an image.", + "Segmentation annotations in an image.", + "Classification annotations in video shots.", + "Video object tracking annotation.", + "Video object detection annotation.", + "Video event annotation.", + "Classification for text. Allowed for continuous evaluation.", + "Entity extraction for text.", + "General classification. Allowed for continuous evaluation." + ], + "type": "string" + }, + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the annotated dataset.", + "items": { + "type": "string" + }, + "type": "array" + }, + "completedExampleCount": { + "description": "Output only. Number of examples that have annotation in the annotated dataset.", + "format": "int64", + "type": "string" + }, + "createTime": { + "description": "Output only. Time the AnnotatedDataset was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.", + "type": "string" + }, + "exampleCount": { + "description": "Output only. Number of examples in the annotated dataset.", + "format": "int64", + "type": "string" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", + "description": "Output only. Per label statistics." + }, + "metadata": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata", + "description": "Output only. Additional information about AnnotatedDataset." + }, + "name": { + "description": "Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata": { + "description": "Metadata on AnnotatedDataset.", + "id": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata", + "properties": { + "boundingPolyConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "description": "Configuration for image bounding box and bounding poly task." + }, + "eventConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", + "description": "Configuration for video event labeling task." + }, + "humanAnnotationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "HumanAnnotationConfig used when requesting the human labeling task for this AnnotatedDataset." + }, + "imageClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "description": "Configuration for image classification task." + }, + "objectDetectionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", + "description": "Configuration for video object detection task." + }, + "objectTrackingConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", + "description": "Configuration for video object tracking task." + }, + "polylineConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", + "description": "Configuration for image polyline task." + }, + "segmentationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", + "description": "Configuration for image segmentation task." + }, + "textClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "description": "Configuration for text classification task." + }, + "textEntityExtractionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", + "description": "Configuration for text entity extraction task." + }, + "videoClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", + "description": "Configuration for video classification task." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Annotation": { + "description": "Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.", + "id": "GoogleCloudDatalabelingV1beta1Annotation", + "properties": { + "annotationMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationMetadata", + "description": "Output only. Annotation metadata, including information like votes for labels." + }, + "annotationSentiment": { + "description": "Output only. Sentiment for this annotation.", + "enum": [ + "ANNOTATION_SENTIMENT_UNSPECIFIED", + "NEGATIVE", + "POSITIVE" + ], + "enumDescriptions": [ + "", + "This annotation describes negatively about the data.", + "This label describes positively about the data." + ], + "type": "string" + }, + "annotationSource": { + "description": "Output only. The source of the annotation.", + "enum": [ + "ANNOTATION_SOURCE_UNSPECIFIED", + "OPERATOR" + ], + "enumDescriptions": [ + "", + "Answer is provided by a human contributor." + ], + "type": "string" + }, + "annotationValue": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationValue", + "description": "Output only. This is the actual annotation value, e.g classification, bounding box values are stored here." + }, + "name": { + "description": "Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationMetadata": { + "description": "Additional information associated with the annotation.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationMetadata", + "properties": { + "operatorMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1OperatorMetadata", + "description": "Metadata related to human labeling." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationSpec": { + "description": "Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "properties": { + "description": { + "description": "Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the AnnotationSpec. Maximum of 64 characters.", + "type": "string" + }, + "index": { + "description": "Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: \"dog\", index: 0 }` and one AnnotationSpec with `{ display_name: \"cat\", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationSpecSet": { + "description": "An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", + "properties": { + "annotationSpecs": { + "description": "Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" + }, + "type": "array" + }, + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the annotation spec set.", + "items": { + "type": "string" + }, + "type": "array" }, - "GoogleCloudDatalabelingV1beta1ClassificationMetadata": { - "description": "Metadata for classification annotations.", - "id": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", - "properties": { - "isMultiLabel": { - "description": "Whether the classification task is multi-label or not.", - "type": "boolean" - } - }, - "type": "object" + "description": { + "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.", + "type": "string" }, - "GoogleCloudDatalabelingV1beta1ClassificationMetrics": { - "description": "Metrics calculated for a classification model.", - "id": "GoogleCloudDatalabelingV1beta1ClassificationMetrics", - "properties": { - "confusionMatrix": { - "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrix", - "description": "Confusion matrix of predicted labels vs. ground truth labels." - }, - "prCurve": { - "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", - "description": "Precision-recall curve based on ground truth labels, predicted labels, and scores for the predicted labels." - } - }, - "type": "object" + "displayName": { + "description": "Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.", + "type": "string" }, - "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry": { - "id": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry", - "properties": { - "confidenceThreshold": { - "description": "Threshold used for this entry. For classification tasks, this is a classification threshold: a predicted label is categorized as positive or negative (in the context of this point on the PR curve) based on whether the label's score meets this threshold. For image object detection (bounding box) tasks, this is the [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) threshold for the context of this point on the PR curve.", - "format": "float", - "type": "number" - }, - "f1Score": { - "description": "Harmonic mean of recall and precision.", - "format": "float", - "type": "number" - }, - "f1ScoreAt1": { - "description": "The harmonic mean of recall_at1 and precision_at1.", - "format": "float", - "type": "number" - }, - "f1ScoreAt5": { - "description": "The harmonic mean of recall_at5 and precision_at5.", - "format": "float", - "type": "number" - }, - "precision": { - "description": "Precision value.", - "format": "float", - "type": "number" - }, - "precisionAt1": { - "description": "Precision value for entries with label that has highest score.", - "format": "float", - "type": "number" - }, - "precisionAt5": { - "description": "Precision value for entries with label that has highest 5 scores.", - "format": "float", - "type": "number" - }, - "recall": { - "description": "Recall value.", - "format": "float", - "type": "number" - }, - "recallAt1": { - "description": "Recall value for entries with label that has highest score.", - "format": "float", - "type": "number" - }, - "recallAt5": { - "description": "Recall value for entries with label that has highest 5 scores.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ConfusionMatrix": { - "description": "Confusion matrix of the model running the classification. Only applicable when the metrics entry aggregates multiple labels. Not applicable when the entry is for a single label.", - "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrix", - "properties": { - "row": { - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Row" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry": { - "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "The annotation spec of a predicted label." - }, - "itemCount": { - "description": "Number of items predicted to have this label. (The ground truth label for these items is the `Row.annotationSpec` of this entry's parent.)", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest": { - "description": "Request message for CreateAnnotationSpecSet.", - "id": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest", - "properties": { - "annotationSpecSet": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", - "description": "Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1CreateDatasetRequest": { - "description": "Request message for CreateDataset.", - "id": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest", - "properties": { - "dataset": { - "$ref": "GoogleCloudDatalabelingV1beta1Dataset", - "description": "Required. The dataset to be created." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest": { - "description": "Request message for CreateEvaluationJob.", - "id": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest", - "properties": { - "job": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob", - "description": "Required. The evaluation job to create." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata": { - "description": "Metadata of a CreateInstruction operation.", - "id": "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata", - "properties": { - "createTime": { - "description": "Timestamp when create instruction request was created.", - "format": "google-datetime", - "type": "string" - }, - "instruction": { - "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", - "type": "string" - }, - "partialFailures": { - "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1CreateInstructionRequest": { - "description": "Request message for CreateInstruction.", - "id": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest", - "properties": { - "instruction": { - "$ref": "GoogleCloudDatalabelingV1beta1Instruction", - "description": "Required. Instruction of how to perform the labeling task." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1CsvInstruction": { - "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file.", - "id": "GoogleCloudDatalabelingV1beta1CsvInstruction", - "properties": { - "gcsFileUri": { - "description": "CSV file for the instruction. Only gcs path is allowed.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1DataItem": { - "description": "DataItem is a piece of data, without annotation. For example, an image.", - "id": "GoogleCloudDatalabelingV1beta1DataItem", - "properties": { - "imagePayload": { - "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload", - "description": "The image payload, a container of the image bytes/uri." - }, - "name": { - "description": "Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", - "type": "string" - }, - "textPayload": { - "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", - "description": "The text payload, a container of text content." - }, - "videoPayload": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload", - "description": "The video payload, a container of the video uri." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Dataset": { - "description": "Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.", - "id": "GoogleCloudDatalabelingV1beta1Dataset", - "properties": { - "blockingResources": { - "description": "Output only. The names of any related resources that are blocking changes to the dataset.", - "items": { - "type": "string" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. Time the dataset is created.", - "format": "google-datetime", - "type": "string" - }, - "dataItemCount": { - "description": "Output only. The number of data items in the dataset.", - "format": "int64", - "type": "string" - }, - "description": { - "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.", - "type": "string" - }, - "displayName": { - "description": "Required. The display name of the dataset. Maximum of 64 characters.", - "type": "string" - }, - "inputConfigs": { - "description": "Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1InputConfig" - }, - "type": "array" - }, - "lastMigrateTime": { - "description": "Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Evaluation": { - "description": "Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.", - "id": "GoogleCloudDatalabelingV1beta1Evaluation", - "properties": { - "annotationType": { - "description": "Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.", - "enum": [ - "ANNOTATION_TYPE_UNSPECIFIED", - "IMAGE_CLASSIFICATION_ANNOTATION", - "IMAGE_BOUNDING_BOX_ANNOTATION", - "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", - "IMAGE_BOUNDING_POLY_ANNOTATION", - "IMAGE_POLYLINE_ANNOTATION", - "IMAGE_SEGMENTATION_ANNOTATION", - "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", - "VIDEO_OBJECT_TRACKING_ANNOTATION", - "VIDEO_OBJECT_DETECTION_ANNOTATION", - "VIDEO_EVENT_ANNOTATION", - "TEXT_CLASSIFICATION_ANNOTATION", - "TEXT_ENTITY_EXTRACTION_ANNOTATION", - "GENERAL_CLASSIFICATION_ANNOTATION" - ], - "enumDescriptions": [ - "", - "Classification annotations in an image. Allowed for continuous evaluation.", - "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", - "Oriented bounding box. The box does not have to be parallel to horizontal line.", - "Bounding poly annotations in an image.", - "Polyline annotations in an image.", - "Segmentation annotations in an image.", - "Classification annotations in video shots.", - "Video object tracking annotation.", - "Video object detection annotation.", - "Video event annotation.", - "Classification for text. Allowed for continuous evaluation.", - "Entity extraction for text.", - "General classification. Allowed for continuous evaluation." - ], - "type": "string" - }, - "config": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig", - "description": "Output only. Options used in the evaluation job that created this evaluation." - }, - "createTime": { - "description": "Output only. Timestamp for when this evaluation was created.", - "format": "google-datetime", - "type": "string" - }, - "evaluatedItemCount": { - "description": "Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes.", - "format": "int64", - "type": "string" - }, - "evaluationJobRunTime": { - "description": "Output only. Timestamp for when the evaluation job that created this evaluation ran.", - "format": "google-datetime", - "type": "string" - }, - "evaluationMetrics": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", - "description": "Output only. Metrics comparing predictions to ground truth labels." - }, - "name": { - "description": "Output only. Resource name of an evaluation. The name has the following format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}'", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1EvaluationConfig": { - "description": "Configuration details used for calculating evaluation metrics and creating an Evaluation.", - "id": "GoogleCloudDatalabelingV1beta1EvaluationConfig", - "properties": { - "boundingBoxEvaluationOptions": { - "$ref": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", - "description": "Only specify this field if the related model performs image object detection (`IMAGE_BOUNDING_BOX_ANNOTATION`). Describes how to evaluate bounding boxes." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1EvaluationJob": { - "description": "Defines an evaluation job that runs periodically to generate Evaluations. [Creating an evaluation job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point for using continuous evaluation.", - "id": "GoogleCloudDatalabelingV1beta1EvaluationJob", - "properties": { - "annotationSpecSet": { - "description": "Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", - "type": "string" - }, - "attempts": { - "description": "Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Attempt" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. Timestamp of when this evaluation job was created.", - "format": "google-datetime", - "type": "string" - }, - "description": { - "description": "Required. Description of the job. The description can be up to 25,000 characters long.", - "type": "string" - }, - "evaluationJobConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", - "description": "Required. Configuration details for the evaluation job." - }, - "labelMissingGroundTruth": { - "description": "Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`.", - "type": "boolean" - }, - "modelVersion": { - "description": "Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: \"projects/{project_id}/models/{model_name}/versions/{version_name}\" There can only be one evaluation job per model version.", - "type": "string" - }, - "name": { - "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"", - "type": "string" - }, - "schedule": { - "description": "Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in [crontab format](/scheduler/docs/configuring/cron-job-schedules) or in an [English-like format](/appengine/docs/standard/python/config/cronref#schedule_format). Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day.", - "type": "string" - }, - "state": { - "description": "Output only. Describes the current state of the job.", - "enum": [ - "STATE_UNSPECIFIED", - "SCHEDULED", - "RUNNING", - "PAUSED", - "STOPPED" - ], - "enumDescriptions": [ - "", - "The job is scheduled to run at the configured interval. You can pause or delete the job. When the job is in this state, it samples prediction input and output from your model version into your BigQuery table as predictions occur.", - "The job is currently running. When the job runs, Data Labeling Service does several things: 1. If you have configured your job to use Data Labeling Service for ground truth labeling, the service creates a Dataset and a labeling task for all data sampled since the last time the job ran. Human labelers provide ground truth labels for your data. Human labeling may take hours, or even days, depending on how much data has been sampled. The job remains in the `RUNNING` state during this time, and it can even be running multiple times in parallel if it gets triggered again (for example 24 hours later) before the earlier run has completed. When human labelers have finished labeling the data, the next step occurs. If you have configured your job to provide your own ground truth labels, Data Labeling Service still creates a Dataset for newly sampled data, but it expects that you have already added ground truth labels to the BigQuery table by this time. The next step occurs immediately. 2. Data Labeling Service creates an Evaluation by comparing your model version's predictions with the ground truth labels. If the job remains in this state for a long time, it continues to sample prediction data into your BigQuery table and will run again at the next interval, even if it causes the job to run multiple times in parallel.", - "The job is not sampling prediction input and output into your BigQuery table and it will not run according to its schedule. You can resume the job.", - "The job has this state right before it is deleted." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig": { - "description": "Provides details for how an evaluation job sends email alerts based on the results of a run.", - "id": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", - "properties": { - "email": { - "description": "Required. An email address to send alerts to.", - "type": "string" - }, - "minAcceptableMeanAveragePrecision": { - "description": "Required. A number between 0 and 1 that describes a minimum mean average precision threshold. When the evaluation job runs, if it calculates that your model version's predictions from the recent interval have meanAveragePrecision below this threshold, then it sends an alert to your specified email.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1EvaluationJobConfig": { - "description": "Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob.", - "id": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", - "properties": { - "bigqueryImportKeys": { - "additionalProperties": { - "type": "string" - }, - "description": "Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON. You can provide the following entries in this field: * `data_json_key`: the data key for prediction input. You must provide either this key or `reference_json_key`. * `reference_json_key`: the data reference key for prediction input. You must provide either this key or `data_json_key`. * `label_json_key`: the label key for prediction output. Required. * `label_score_json_key`: the score key for prediction output. Required. * `bounding_box_json_key`: the bounding box key for prediction output. Required if your model version perform image object detection. Learn [how to configure prediction keys](/ml-engine/docs/continuous-evaluation/create-job#prediction-keys).", - "type": "object" - }, - "boundingPolyConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", - "description": "Specify this field if your model version performs image object detection (bounding box detection). `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet." - }, - "evaluationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig", - "description": "Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the `boundingBoxEvaluationOptions` field within this configuration. Otherwise, provide an empty object for this configuration." - }, - "evaluationJobAlertConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", - "description": "Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run." - }, - "exampleCount": { - "description": "Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides `example_sample_percentage`: even if the service has not sampled enough predictions to fulfill `example_sample_perecentage` during an interval, it stops sampling predictions when it meets this limit.", - "format": "int32", - "type": "integer" - }, - "exampleSamplePercentage": { - "description": "Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.", - "format": "double", - "type": "number" - }, - "humanAnnotationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to `true` for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field. Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the `instruction` field within this configuration." - }, - "imageClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", - "description": "Specify this field if your model version performs image classification or general classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config." - }, - "inputConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1InputConfig", - "description": "Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields: * `dataType` must be one of `IMAGE`, `TEXT`, or `GENERAL_DATA`. * `annotationType` must be one of `IMAGE_CLASSIFICATION_ANNOTATION`, `TEXT_CLASSIFICATION_ANNOTATION`, `GENERAL_CLASSIFICATION_ANNOTATION`, or `IMAGE_BOUNDING_BOX_ANNOTATION` (image object detection). * If your machine learning model performs classification, you must specify `classificationMetadata.isMultiLabel`. * You must specify `bigquerySource` (not `gcsSource`)." - }, - "textClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", - "description": "Specify this field if your model version performs text classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1EvaluationMetrics": { - "id": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", - "properties": { - "classificationMetrics": { - "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetrics" - }, - "objectDetectionMetrics": { - "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1EventConfig": { - "description": "Config for video event human labeling task.", - "id": "GoogleCloudDatalabelingV1beta1EventConfig", - "properties": { - "annotationSpecSets": { - "description": "Required. The list of annotation spec set resource name. Similar to video classification, we support selecting event from multiple AnnotationSpecSet at the same time.", - "items": { - "type": "string" - }, - "type": "array" - }, - "clipLength": { - "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 60s.", - "format": "int32", - "type": "integer" - }, - "overlapLength": { - "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 1s.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Example": { - "description": "An Example is a piece of data and its annotation. For example, an image with label \"house\".", - "id": "GoogleCloudDatalabelingV1beta1Example", - "properties": { - "annotations": { - "description": "Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Annotation" - }, - "type": "array" - }, - "imagePayload": { - "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload", - "description": "The image payload, a container of the image bytes/uri." - }, - "name": { - "description": "Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", - "type": "string" - }, - "textPayload": { - "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", - "description": "The text payload, a container of the text content." - }, - "videoPayload": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload", - "description": "The video payload, a container of the video uri." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ExampleComparison": { - "description": "Example comparisons comparing ground truth output and predictions for a specific input.", - "id": "GoogleCloudDatalabelingV1beta1ExampleComparison", - "properties": { - "groundTruthExample": { - "$ref": "GoogleCloudDatalabelingV1beta1Example", - "description": "The ground truth output for the input." - }, - "modelCreatedExamples": { - "description": "Predictions by the model for the input.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Example" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata": { - "description": "Metadata of an ExportData operation.", - "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when export dataset request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", - "type": "string" - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse": { - "description": "Response used for ExportDataset longrunning operation.", - "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "dataset": { - "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", - "type": "string" - }, - "exportCount": { - "description": "Output only. Number of examples exported successfully.", - "format": "int32", - "type": "integer" - }, - "labelStats": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", - "description": "Output only. Statistic infos of labels in the exported dataset." - }, - "outputConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", - "description": "Output only. output_config in the ExportData request." - }, - "totalCount": { - "description": "Output only. Total number of examples requested to export", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ExportDataRequest": { - "description": "Request message for ExportData API.", - "id": "GoogleCloudDatalabelingV1beta1ExportDataRequest", - "properties": { - "annotatedDataset": { - "description": "Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", - "type": "string" - }, - "filter": { - "description": "Optional. Filter is not supported at this moment.", - "type": "string" - }, - "outputConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", - "description": "Required. Specify the output destination." - }, - "userEmailAddress": { - "description": "Email of the user who started the export task and should be notified by email. If empty no notification will be sent.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1FeedbackMessage": { - "description": "A feedback message inside a feedback thread.", - "id": "GoogleCloudDatalabelingV1beta1FeedbackMessage", - "properties": { - "body": { - "description": "String content of the feedback. Maximum of 10000 characters.", - "type": "string" - }, - "createTime": { - "description": "Create time.", - "format": "google-datetime", - "type": "string" - }, - "image": { - "description": "The image storing this feedback if the feedback is an image representing operator's comments.", - "format": "byte", - "type": "string" - }, - "name": { - "description": "Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}'", - "type": "string" - }, - "operatorFeedbackMetadata": { - "$ref": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata" - }, - "requesterFeedbackMetadata": { - "$ref": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1FeedbackThread": { - "description": "A feedback thread of a certain labeling task on a certain annotated dataset.", - "id": "GoogleCloudDatalabelingV1beta1FeedbackThread", - "properties": { - "feedbackThreadMetadata": { - "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", - "description": "Metadata regarding the feedback thread." - }, - "name": { - "description": "Name of the feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata": { - "id": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", - "properties": { - "createTime": { - "description": "When the thread is created", - "format": "google-datetime", - "type": "string" - }, - "lastUpdateTime": { - "description": "When the thread is last updated.", - "format": "google-datetime", - "type": "string" - }, - "status": { - "enum": [ - "FEEDBACK_THREAD_STATUS_UNSPECIFIED", - "NEW", - "REPLIED" - ], - "enumDescriptions": [ - "", - "Feedback thread is created with no reply;", - "Feedback thread is replied at least once;" - ], - "type": "string" - }, - "thumbnail": { - "description": "An image thumbnail of this thread.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1GcsDestination": { - "description": "Export destination of the data.Only gcs path is allowed in output_uri.", - "id": "GoogleCloudDatalabelingV1beta1GcsDestination", - "properties": { - "mimeType": { - "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", - "type": "string" - }, - "outputUri": { - "description": "Required. The output uri of destination file.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1GcsFolderDestination": { - "description": "Export folder destination of the data.", - "id": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", - "properties": { - "outputFolderUri": { - "description": "Required. Cloud Storage directory to export data to.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1GcsSource": { - "description": "Source of the Cloud Storage file to be imported.", - "id": "GoogleCloudDatalabelingV1beta1GcsSource", - "properties": { - "inputUri": { - "description": "Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).", - "type": "string" - }, - "mimeType": { - "description": "Required. The format of the source file. Only \"text/csv\" is supported.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig": { - "description": "Configuration for how human labeling task should be done.", - "id": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "properties": { - "annotatedDatasetDescription": { - "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", - "type": "string" - }, - "annotatedDatasetDisplayName": { - "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", - "type": "string" - }, - "contributorEmails": { - "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", - "items": { - "type": "string" - }, - "type": "array" - }, - "instruction": { - "description": "Required. Instruction resource name.", - "type": "string" - }, - "labelGroup": { - "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", - "type": "string" - }, - "languageCode": { - "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", - "type": "string" - }, - "questionDuration": { - "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", - "format": "google-duration", - "type": "string" - }, - "replicaCount": { - "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", - "format": "int32", - "type": "integer" - }, - "userEmailAddress": { - "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation": { - "description": "Image bounding poly annotation. It represents a polygon including bounding box in the image.", - "id": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of object in this bounding polygon." - }, - "boundingPoly": { - "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" - }, - "normalizedBoundingPoly": { - "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation": { - "description": "Image classification annotation definition.", - "id": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of image." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImageClassificationConfig": { - "description": "Config for image classification human labeling task.", - "id": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", - "properties": { - "allowMultiLabel": { - "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image.", - "type": "boolean" - }, - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - }, - "answerAggregationType": { - "description": "Optional. The type of how to aggregate answers.", - "enum": [ - "STRING_AGGREGATION_TYPE_UNSPECIFIED", - "MAJORITY_VOTE", - "UNANIMOUS_VOTE", - "NO_AGGREGATION" - ], - "enumDescriptions": [ - "", - "Majority vote to aggregate answers.", - "Unanimous answers will be adopted.", - "Preserve all answers by crowd compute." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImagePayload": { - "description": "Container of information about an image.", - "id": "GoogleCloudDatalabelingV1beta1ImagePayload", - "properties": { - "imageThumbnail": { - "description": "A byte string of a thumbnail image.", - "format": "byte", - "type": "string" - }, - "imageUri": { - "description": "Image uri from the user bucket.", - "type": "string" - }, - "mimeType": { - "description": "Image format.", - "type": "string" - }, - "signedUri": { - "description": "Signed uri of the image file in the service bucket.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation": { - "description": "A polyline for the image annotation.", - "id": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of this polyline." - }, - "normalizedPolyline": { - "$ref": "GoogleCloudDatalabelingV1beta1NormalizedPolyline" - }, - "polyline": { - "$ref": "GoogleCloudDatalabelingV1beta1Polyline" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation": { - "description": "Image segmentation annotation.", - "id": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation", - "properties": { - "annotationColors": { - "additionalProperties": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" - }, - "description": "The mapping between rgb color and annotation spec. The key is the rgb color represented in format of rgb(0, 0, 0). The value is the AnnotationSpec.", - "type": "object" - }, - "imageBytes": { - "description": "A byte string of a full image's color map.", - "format": "byte", - "type": "string" - }, - "mimeType": { - "description": "Image format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata": { - "description": "Metadata of an ImportData operation.", - "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata", - "properties": { - "createTime": { - "description": "Output only. Timestamp when import dataset request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", - "type": "string" - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse": { - "description": "Response used for ImportData longrunning operation.", - "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse", - "properties": { - "dataset": { - "description": "Ouptut only. The name of imported dataset.", - "type": "string" - }, - "importCount": { - "description": "Output only. Number of examples imported successfully.", - "format": "int32", - "type": "integer" - }, - "totalCount": { - "description": "Output only. Total number of examples requested to import", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ImportDataRequest": { - "description": "Request message for ImportData API.", - "id": "GoogleCloudDatalabelingV1beta1ImportDataRequest", - "properties": { - "inputConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1InputConfig", - "description": "Required. Specify the input source of the data." - }, - "userEmailAddress": { - "description": "Email of the user who started the import task and should be notified by email. If empty no notification will be sent.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1InputConfig": { - "description": "The configuration of input data, including data type, location, etc.", - "id": "GoogleCloudDatalabelingV1beta1InputConfig", - "properties": { - "annotationType": { - "description": "Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.", - "enum": [ - "ANNOTATION_TYPE_UNSPECIFIED", - "IMAGE_CLASSIFICATION_ANNOTATION", - "IMAGE_BOUNDING_BOX_ANNOTATION", - "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", - "IMAGE_BOUNDING_POLY_ANNOTATION", - "IMAGE_POLYLINE_ANNOTATION", - "IMAGE_SEGMENTATION_ANNOTATION", - "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", - "VIDEO_OBJECT_TRACKING_ANNOTATION", - "VIDEO_OBJECT_DETECTION_ANNOTATION", - "VIDEO_EVENT_ANNOTATION", - "TEXT_CLASSIFICATION_ANNOTATION", - "TEXT_ENTITY_EXTRACTION_ANNOTATION", - "GENERAL_CLASSIFICATION_ANNOTATION" - ], - "enumDescriptions": [ - "", - "Classification annotations in an image. Allowed for continuous evaluation.", - "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", - "Oriented bounding box. The box does not have to be parallel to horizontal line.", - "Bounding poly annotations in an image.", - "Polyline annotations in an image.", - "Segmentation annotations in an image.", - "Classification annotations in video shots.", - "Video object tracking annotation.", - "Video object detection annotation.", - "Video event annotation.", - "Classification for text. Allowed for continuous evaluation.", - "Entity extraction for text.", - "General classification. Allowed for continuous evaluation." - ], - "type": "string" - }, - "bigquerySource": { - "$ref": "GoogleCloudDatalabelingV1beta1BigQuerySource", - "description": "Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob." - }, - "classificationMetadata": { - "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", - "description": "Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification." - }, - "dataType": { - "description": "Required. Data type must be specifed when user tries to import data.", - "enum": [ - "DATA_TYPE_UNSPECIFIED", - "IMAGE", - "VIDEO", - "TEXT", - "GENERAL_DATA" - ], - "enumDescriptions": [ - "Data type is unspecified.", - "Allowed for continuous evaluation.", - "Video data type.", - "Allowed for continuous evaluation.", - "Allowed for continuous evaluation." - ], - "type": "string" - }, - "gcsSource": { - "$ref": "GoogleCloudDatalabelingV1beta1GcsSource", - "description": "Source located in Cloud Storage." - }, - "textMetadata": { - "$ref": "GoogleCloudDatalabelingV1beta1TextMetadata", - "description": "Required for text import, as language code must be specified." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Instruction": { - "description": "Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.", - "id": "GoogleCloudDatalabelingV1beta1Instruction", - "properties": { - "blockingResources": { - "description": "Output only. The names of any related resources that are blocking changes to the instruction.", - "items": { - "type": "string" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. Creation time of instruction.", - "format": "google-datetime", - "type": "string" - }, - "csvInstruction": { - "$ref": "GoogleCloudDatalabelingV1beta1CsvInstruction", - "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data." - }, - "dataType": { - "description": "Required. The data type of this instruction.", - "enum": [ - "DATA_TYPE_UNSPECIFIED", - "IMAGE", - "VIDEO", - "TEXT", - "GENERAL_DATA" - ], - "enumDescriptions": [ - "Data type is unspecified.", - "Allowed for continuous evaluation.", - "Video data type.", - "Allowed for continuous evaluation.", - "Allowed for continuous evaluation." - ], - "type": "string" - }, - "description": { - "description": "Optional. User-provided description of the instruction. The description can be up to 10000 characters long.", - "type": "string" - }, - "displayName": { - "description": "Required. The display name of the instruction. Maximum of 64 characters.", - "type": "string" - }, - "name": { - "description": "Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", - "type": "string" - }, - "pdfInstruction": { - "$ref": "GoogleCloudDatalabelingV1beta1PdfInstruction", - "description": "Instruction from a PDF document. The PDF should be in a Cloud Storage bucket." - }, - "updateTime": { - "description": "Output only. Last update time of instruction.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata": { - "description": "Details of LabelImageBoundingPoly operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata": { - "description": "Metadata of a LabelImageClassification operation.", - "id": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata": { - "description": "Details of LabelImagePolyline operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelImageRequest": { - "description": "Request message for starting an image labeling task.", - "id": "GoogleCloudDatalabelingV1beta1LabelImageRequest", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Required. Basic human annotation config." - }, - "boundingPolyConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", - "description": "Configuration for bounding box and bounding poly task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." - }, - "feature": { - "description": "Required. The type of image labeling task.", - "enum": [ - "FEATURE_UNSPECIFIED", - "CLASSIFICATION", - "BOUNDING_BOX", - "ORIENTED_BOUNDING_BOX", - "BOUNDING_POLY", - "POLYLINE", - "SEGMENTATION" - ], - "enumDescriptions": [ - "", - "Label whole image with one or more of labels.", - "Label image with bounding boxes for labels.", - "Label oriented bounding box. The box does not have to be parallel to horizontal line.", - "Label images with bounding poly. A bounding poly is a plane figure that is bounded by a finite chain of straight line segments closing in a loop.", - "Label images with polyline. Polyline is formed by connected line segments which are not in closed form.", - "Label images with segmentation. Segmentation is different from bounding poly since it is more fine-grained, pixel level annotation." - ], - "type": "string" - }, - "imageClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", - "description": "Configuration for image classification task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." - }, - "polylineConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", - "description": "Configuration for polyline task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." - }, - "segmentationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", - "description": "Configuration for segmentation task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata": { - "description": "Details of a LabelImageSegmentation operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelOperationMetadata": { - "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", - "id": "GoogleCloudDatalabelingV1beta1LabelOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when labeling request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", - "type": "string" - }, - "imageBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", - "description": "Details of label image bounding box operation." - }, - "imageBoundingPolyDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", - "description": "Details of label image bounding poly operation." - }, - "imageClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", - "description": "Details of label image classification operation." - }, - "imageOrientedBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", - "description": "Details of label image oriented bounding box operation." - }, - "imagePolylineDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", - "description": "Details of label image polyline operation." - }, - "imageSegmentationDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", - "description": "Details of label image segmentation operation." - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "progressPercent": { - "description": "Output only. Progress of label operation. Range: [0, 100].", - "format": "int32", - "type": "integer" - }, - "textClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", - "description": "Details of label text classification operation." - }, - "textEntityExtractionDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", - "description": "Details of label text entity extraction operation." - }, - "videoClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", - "description": "Details of label video classification operation." - }, - "videoEventDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", - "description": "Details of label video event operation." - }, - "videoObjectDetectionDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", - "description": "Details of label video object detection operation." - }, - "videoObjectTrackingDetails": { - "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata", - "description": "Details of label video object tracking operation." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelStats": { - "description": "Statistics about annotation specs.", - "id": "GoogleCloudDatalabelingV1beta1LabelStats", - "properties": { - "exampleCount": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata": { - "description": "Details of a LabelTextClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata": { - "description": "Details of a LabelTextEntityExtraction operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelTextRequest": { - "description": "Request message for LabelText.", - "id": "GoogleCloudDatalabelingV1beta1LabelTextRequest", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Required. Basic human annotation config." - }, - "feature": { - "description": "Required. The type of text labeling task.", - "enum": [ - "FEATURE_UNSPECIFIED", - "TEXT_CLASSIFICATION", - "TEXT_ENTITY_EXTRACTION" - ], - "enumDescriptions": [ - "", - "Label text content to one of more labels.", - "Label entities and their span in text." - ], - "type": "string" - }, - "textClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", - "description": "Configuration for text classification task. One of text_classification_config and text_entity_extraction_config is required." - }, - "textEntityExtractionConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", - "description": "Configuration for entity extraction task. One of text_classification_config and text_entity_extraction_config is required." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata": { - "description": "Details of a LabelVideoClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata": { - "description": "Details of a LabelVideoEvent operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata": { - "description": "Details of a LabelVideoObjectDetection operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata": { - "description": "Details of a LabelVideoObjectTracking operation metadata.", - "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1LabelVideoRequest": { - "description": "Request message for LabelVideo.", - "id": "GoogleCloudDatalabelingV1beta1LabelVideoRequest", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", - "description": "Required. Basic human annotation config." - }, - "eventConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", - "description": "Configuration for video event task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." - }, - "feature": { - "description": "Required. The type of video labeling task.", - "enum": [ - "FEATURE_UNSPECIFIED", - "CLASSIFICATION", - "OBJECT_DETECTION", - "OBJECT_TRACKING", - "EVENT" - ], - "enumDescriptions": [ - "", - "Label whole video or video segment with one or more labels.", - "Label objects with bounding box on image frames extracted from the video.", - "Label and track objects in video.", - "Label the range of video for the specified events." - ], - "type": "string" - }, - "objectDetectionConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", - "description": "Configuration for video object detection task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." - }, - "objectTrackingConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", - "description": "Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." - }, - "videoClassificationConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", - "description": "Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse": { - "description": "Results of listing annotated datasets for a dataset.", - "id": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse", - "properties": { - "annotatedDatasets": { - "description": "The list of annotated datasets to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse": { - "description": "Results of listing annotation spec set under a project.", - "id": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse", - "properties": { - "annotationSpecSets": { - "description": "The list of annotation spec sets.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListDataItemsResponse": { - "description": "Results of listing data items in a dataset.", - "id": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse", - "properties": { - "dataItems": { - "description": "The list of data items to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1DataItem" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListDatasetsResponse": { - "description": "Results of listing datasets within a project.", - "id": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse", - "properties": { - "datasets": { - "description": "The list of datasets to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Dataset" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse": { - "description": "Results for listing evaluation jobs.", - "id": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse", - "properties": { - "evaluationJobs": { - "description": "The list of evaluation jobs to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListExamplesResponse": { - "description": "Results of listing Examples in and annotated dataset.", - "id": "GoogleCloudDatalabelingV1beta1ListExamplesResponse", - "properties": { - "examples": { - "description": "The list of examples to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Example" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse": { - "description": "Results for listing FeedbackMessages.", - "id": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse", - "properties": { - "feedbackMessages": { - "description": "The list of feedback messages to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse": { - "description": "Results for listing FeedbackThreads.", - "id": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse", - "properties": { - "feedbackThreads": { - "description": "The list of feedback threads to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ListInstructionsResponse": { - "description": "Results of listing instructions under a project.", - "id": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse", - "properties": { - "instructions": { - "description": "The list of Instructions to return.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Instruction" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly": { - "description": "Normalized bounding polygon.", - "id": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly", - "properties": { - "normalizedVertices": { - "description": "The bounding polygon normalized vertices.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1NormalizedPolyline": { - "description": "Normalized polyline.", - "id": "GoogleCloudDatalabelingV1beta1NormalizedPolyline", - "properties": { - "normalizedVertices": { - "description": "The normalized polyline vertices.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1NormalizedVertex": { - "description": "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.", - "id": "GoogleCloudDatalabelingV1beta1NormalizedVertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "float", - "type": "number" - }, - "y": { - "description": "Y coordinate.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig": { - "description": "Config for video object detection human labeling task. Object detection will be conducted on the images extracted from the video, and those objects will be labeled with bounding boxes. User need to specify the number of images to be extracted per second as the extraction frame rate.", - "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", - "properties": { - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - }, - "extractionFrameRate": { - "description": "Required. Number of frames per second to be extracted from the video.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics": { - "description": "Metrics calculated for an image object detection (bounding box) model.", - "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics", - "properties": { - "prCurve": { - "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", - "description": "Precision-recall curve." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig": { - "description": "Config for video object tracking human labeling task.", - "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", - "properties": { - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - }, - "clipLength": { - "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 20s.", - "format": "int32", - "type": "integer" - }, - "overlapLength": { - "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 0.3s.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame": { - "description": "Video frame level annotation for object detection and tracking.", - "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" - }, - "normalizedBoundingPoly": { - "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" - }, - "timeOffset": { - "description": "The time offset of this frame relative to the beginning of the video.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata": { - "description": "Metadata describing the feedback from the operator.", - "id": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1OperatorMetadata": { - "description": "General information useful for labels coming from contributors.", - "id": "GoogleCloudDatalabelingV1beta1OperatorMetadata", - "properties": { - "comments": { - "description": "Comments from contributors.", - "items": { - "type": "string" - }, - "type": "array" - }, - "labelVotes": { - "description": "The total number of contributors that choose this label.", - "format": "int32", - "type": "integer" - }, - "score": { - "description": "Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).", - "format": "float", - "type": "number" - }, - "totalVotes": { - "description": "The total number of contributors that answer this question.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1OutputConfig": { - "description": "The configuration of output data.", - "id": "GoogleCloudDatalabelingV1beta1OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDatalabelingV1beta1GcsDestination", - "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." - }, - "gcsFolderDestination": { - "$ref": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", - "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest": { - "description": "Request message for PauseEvaluationJob.", - "id": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1PdfInstruction": { - "description": "Instruction from a PDF file.", - "id": "GoogleCloudDatalabelingV1beta1PdfInstruction", - "properties": { - "gcsFileUri": { - "description": "PDF file for the instruction. Only gcs path is allowed.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Polyline": { - "description": "A line with multiple line segments.", - "id": "GoogleCloudDatalabelingV1beta1Polyline", - "properties": { - "vertices": { - "description": "The polyline vertices.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Vertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1PolylineConfig": { - "description": "Config for image polyline human labeling task.", - "id": "GoogleCloudDatalabelingV1beta1PolylineConfig", - "properties": { - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - }, - "instructionMessage": { - "description": "Optional. Instruction message showed on contributors UI.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1PrCurve": { - "id": "GoogleCloudDatalabelingV1beta1PrCurve", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "The annotation spec of the label for which the precision-recall curve calculated. If this field is empty, that means the precision-recall curve is an aggregate curve for all labels." - }, - "areaUnderCurve": { - "description": "Area under the precision-recall curve. Not to be confused with area under a receiver operating characteristic (ROC) curve.", - "format": "float", - "type": "number" - }, - "confidenceMetricsEntries": { - "description": "Entries that make up the precision-recall graph. Each entry is a \"point\" on the graph drawn for a different `confidence_threshold`.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry" - }, - "type": "array" - }, - "meanAveragePrecision": { - "description": "Mean average prcision of this curve.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata": { - "description": "Metadata describing the feedback from the labeling task requester.", - "id": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest": { - "description": "Request message ResumeEvaluationJob.", - "id": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Row": { - "description": "A row in the confusion matrix. Each entry in this row has the same ground truth label.", - "id": "GoogleCloudDatalabelingV1beta1Row", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "The annotation spec of the ground truth label for this row." - }, - "entries": { - "description": "A list of the confusion matrix entries. One entry for each possible predicted label.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse": { - "description": "Results of searching evaluations.", - "id": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse", - "properties": { - "evaluations": { - "description": "The list of evaluations matching the search.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest": { - "description": "Request message of SearchExampleComparisons.", - "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest", - "properties": { - "pageSize": { - "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", - "format": "int32", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest. If you don't specify this field, the API call requests the first page of the search.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse": { - "description": "Results of searching example comparisons.", - "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse", - "properties": { - "exampleComparisons": { - "description": "A list of example comparisons matching the search criteria.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1ExampleComparison" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1SegmentationConfig": { - "description": "Config for image segmentation", - "id": "GoogleCloudDatalabelingV1beta1SegmentationConfig", - "properties": { - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name. format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", - "type": "string" - }, - "instructionMessage": { - "description": "Instruction message showed on labelers UI.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1SentimentConfig": { - "description": "Config for setting up sentiments.", - "id": "GoogleCloudDatalabelingV1beta1SentimentConfig", - "properties": { - "enableLabelSentimentSelection": { - "description": "If set to true, contributors will have the option to select sentiment of the label they selected, to mark it as negative or positive label. Default is false.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1SequentialSegment": { - "description": "Start and end position in a sequence (e.g. text segment).", - "id": "GoogleCloudDatalabelingV1beta1SequentialSegment", - "properties": { - "end": { - "description": "End position (exclusive).", - "format": "int32", - "type": "integer" - }, - "start": { - "description": "Start position (inclusive).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation": { - "description": "Text classification annotation.", - "id": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of the text." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1TextClassificationConfig": { - "description": "Config for text classification human labeling task.", - "id": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", - "properties": { - "allowMultiLabel": { - "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one text segment.", - "type": "boolean" - }, - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - }, - "sentimentConfig": { - "$ref": "GoogleCloudDatalabelingV1beta1SentimentConfig", - "description": "Optional. Configs for sentiment selection. We deprecate sentiment analysis in data labeling side as it is incompatible with uCAIP." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation": { - "description": "Text entity extraction annotation.", - "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of the text entities." - }, - "sequentialSegment": { - "$ref": "GoogleCloudDatalabelingV1beta1SequentialSegment", - "description": "Position of the entity." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig": { - "description": "Config for text entity extraction human labeling task.", - "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", - "properties": { - "annotationSpecSet": { - "description": "Required. Annotation spec set resource name.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1TextMetadata": { - "description": "Metadata for the text.", - "id": "GoogleCloudDatalabelingV1beta1TextMetadata", - "properties": { - "languageCode": { - "description": "The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1TextPayload": { - "description": "Container of information about a piece of text.", - "id": "GoogleCloudDatalabelingV1beta1TextPayload", - "properties": { - "textContent": { - "description": "Text content.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1TimeSegment": { - "description": "A time period inside of an example that has a time dimension (e.g. video).", - "id": "GoogleCloudDatalabelingV1beta1TimeSegment", - "properties": { - "endTimeOffset": { - "description": "End of the time segment (exclusive), represented as the duration since the example start.", - "format": "google-duration", - "type": "string" - }, - "startTimeOffset": { - "description": "Start of the time segment (inclusive), represented as the duration since the example start.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1Vertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", - "id": "GoogleCloudDatalabelingV1beta1Vertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" - }, - "y": { - "description": "Y coordinate.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation": { - "description": "Video classification annotation.", - "id": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of the segment specified by time_segment." - }, - "timeSegment": { - "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", - "description": "The time segment of the video to which the annotation applies." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1VideoClassificationConfig": { - "description": "Config for video classification human labeling task. Currently two types of video classification are supported: 1. Assign labels on the entire video. 2. Split the video into multiple video clips based on camera shot, and assign labels on each video clip.", - "id": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", - "properties": { - "annotationSpecSetConfigs": { - "description": "Required. The list of annotation spec set configs. Since watching a video clip takes much longer time than an image, we support label with multiple AnnotationSpecSet at the same time. Labels in each AnnotationSpecSet will be shown in a group to contributors. Contributors can select one or more (depending on whether to allow multi label) from each group.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig" - }, - "type": "array" - }, - "applyShotDetection": { - "description": "Optional. Option to apply shot detection on the video.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1VideoEventAnnotation": { - "description": "Video event annotation.", - "id": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of the event in this annotation." - }, - "timeSegment": { - "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", - "description": "The time segment of the video to which the annotation applies." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation": { - "description": "Video object tracking annotation.", - "id": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation", - "properties": { - "annotationSpec": { - "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", - "description": "Label of the object tracked in this annotation." - }, - "objectTrackingFrames": { - "description": "The list of frames where this object track appears.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame" - }, - "type": "array" - }, - "timeSegment": { - "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", - "description": "The time segment of the video to which object tracking applies." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1VideoPayload": { - "description": "Container of information of a video.", - "id": "GoogleCloudDatalabelingV1beta1VideoPayload", - "properties": { - "frameRate": { - "description": "FPS of the video.", - "format": "float", - "type": "number" - }, - "mimeType": { - "description": "Video format.", - "type": "string" - }, - "signedUri": { - "description": "Signed uri of the video file in the service bucket.", - "type": "string" - }, - "videoThumbnails": { - "description": "The list of video thumbnails.", - "items": { - "$ref": "GoogleCloudDatalabelingV1beta1VideoThumbnail" - }, - "type": "array" - }, - "videoUri": { - "description": "Video uri from the user bucket.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1beta1VideoThumbnail": { - "description": "Container of information of a video thumbnail.", - "id": "GoogleCloudDatalabelingV1beta1VideoThumbnail", - "properties": { - "thumbnail": { - "description": "A byte string of the video frame.", - "format": "byte", - "type": "string" - }, - "timeOffset": { - "description": "Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata": { - "description": "Metadata of a CreateInstruction operation.", - "id": "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata", - "properties": { - "createTime": { - "description": "Timestamp when create instruction request was created.", - "format": "google-datetime", - "type": "string" - }, - "instruction": { - "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", - "type": "string" - }, - "partialFailures": { - "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata": { - "description": "Metadata of an ExportData operation.", - "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when export dataset request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", - "type": "string" - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse": { - "description": "Response used for ExportDataset longrunning operation.", - "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "dataset": { - "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", - "type": "string" - }, - "exportCount": { - "description": "Output only. Number of examples exported successfully.", - "format": "int32", - "type": "integer" - }, - "labelStats": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelStats", - "description": "Output only. Statistic infos of labels in the exported dataset." - }, - "outputConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1OutputConfig", - "description": "Output only. output_config in the ExportData request." - }, - "totalCount": { - "description": "Output only. Total number of examples requested to export", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1GcsDestination": { - "description": "Export destination of the data.Only gcs path is allowed in output_uri.", - "id": "GoogleCloudDatalabelingV1p1alpha1GcsDestination", - "properties": { - "mimeType": { - "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", - "type": "string" - }, - "outputUri": { - "description": "Required. The output uri of destination file.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination": { - "description": "Export folder destination of the data.", - "id": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", - "properties": { - "outputFolderUri": { - "description": "Required. Cloud Storage directory to export data to.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata": { - "description": "Metadata of an GenerateAnalysisReport operation.", - "id": "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata", - "properties": { - "createTime": { - "description": "Timestamp when generate report request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "The name of the dataset for which the analysis report is generated. Format: \"projects/*/datasets/*\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig": { - "description": "Configuration for how human labeling task should be done.", - "id": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "properties": { - "annotatedDatasetDescription": { - "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", - "type": "string" - }, - "annotatedDatasetDisplayName": { - "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", - "type": "string" - }, - "contributorEmails": { - "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", - "items": { - "type": "string" - }, - "type": "array" - }, - "instruction": { - "description": "Required. Instruction resource name.", - "type": "string" - }, - "labelGroup": { - "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", - "type": "string" - }, - "languageCode": { - "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", - "type": "string" - }, - "questionDuration": { - "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", - "format": "google-duration", - "type": "string" - }, - "replicaCount": { - "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", - "format": "int32", - "type": "integer" - }, - "userEmailAddress": { - "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata": { - "description": "Metadata of an ImportData operation.", - "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata", - "properties": { - "createTime": { - "description": "Output only. Timestamp when import dataset request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", - "type": "string" - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse": { - "description": "Response used for ImportData longrunning operation.", - "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse", - "properties": { - "dataset": { - "description": "Ouptut only. The name of imported dataset.", - "type": "string" - }, - "importCount": { - "description": "Output only. Number of examples imported successfully.", - "format": "int32", - "type": "integer" - }, - "totalCount": { - "description": "Output only. Total number of examples requested to import", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata": { - "description": "Details of LabelImageBoundingPoly operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata": { - "description": "Metadata of a LabelImageClassification operation.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata": { - "description": "Details of LabelImagePolyline operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata": { - "description": "Details of a LabelImageSegmentation operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata": { - "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when labeling request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", - "type": "string" - }, - "imageBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", - "description": "Details of label image bounding box operation." - }, - "imageBoundingPolyDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", - "description": "Details of label image bounding poly operation." - }, - "imageClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", - "description": "Details of label image classification operation." - }, - "imageOrientedBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", - "description": "Details of label image oriented bounding box operation." - }, - "imagePolylineDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", - "description": "Details of label image polyline operation." - }, - "imageSegmentationDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", - "description": "Details of label image segmentation operation." - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "progressPercent": { - "description": "Output only. Progress of label operation. Range: [0, 100].", - "format": "int32", - "type": "integer" - }, - "textClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", - "description": "Details of label text classification operation." - }, - "textEntityExtractionDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", - "description": "Details of label text entity extraction operation." - }, - "videoClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", - "description": "Details of label video classification operation." - }, - "videoEventDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", - "description": "Details of label video event operation." - }, - "videoObjectDetectionDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", - "description": "Details of label video object detection operation." - }, - "videoObjectTrackingDetails": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", - "description": "Details of label video object tracking operation." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelStats": { - "description": "Statistics about annotation specs.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelStats", - "properties": { - "exampleCount": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata": { - "description": "Details of a LabelTextClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata": { - "description": "Details of a LabelTextEntityExtraction operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata": { - "description": "Details of a LabelVideoClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata": { - "description": "Details of a LabelVideoEvent operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata": { - "description": "Details of a LabelVideoObjectDetection operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata": { - "description": "Details of a LabelVideoObjectTracking operation metadata.", - "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p1alpha1OutputConfig": { - "description": "The configuration of output data.", - "id": "GoogleCloudDatalabelingV1p1alpha1OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsDestination", - "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." - }, - "gcsFolderDestination": { - "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", - "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata": { - "description": "Metadata of a CreateInstruction operation.", - "id": "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata", - "properties": { - "createTime": { - "description": "Timestamp when create instruction request was created.", - "format": "google-datetime", - "type": "string" - }, - "instruction": { - "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", - "type": "string" - }, - "partialFailures": { - "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata": { - "description": "Metadata of an ExportData operation.", - "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when export dataset request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", - "type": "string" - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse": { - "description": "Response used for ExportDataset longrunning operation.", - "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "dataset": { - "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", - "type": "string" - }, - "exportCount": { - "description": "Output only. Number of examples exported successfully.", - "format": "int32", - "type": "integer" - }, - "labelStats": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelStats", - "description": "Output only. Statistic infos of labels in the exported dataset." - }, - "outputConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", - "description": "Output only. output_config in the ExportData request." - }, - "totalCount": { - "description": "Output only. Total number of examples requested to export", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1GcsDestination": { - "description": "Export destination of the data.Only gcs path is allowed in output_uri.", - "id": "GoogleCloudDatalabelingV1p2alpha1GcsDestination", - "properties": { - "mimeType": { - "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", - "type": "string" - }, - "outputUri": { - "description": "Required. The output uri of destination file.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination": { - "description": "Export folder destination of the data.", - "id": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination", - "properties": { - "outputFolderUri": { - "description": "Required. Cloud Storage directory to export data to.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig": { - "description": "Configuration for how human labeling task should be done.", - "id": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "properties": { - "annotatedDatasetDescription": { - "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", - "type": "string" - }, - "annotatedDatasetDisplayName": { - "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", - "type": "string" - }, - "contributorEmails": { - "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", - "items": { - "type": "string" - }, - "type": "array" - }, - "instruction": { - "description": "Required. Instruction resource name.", - "type": "string" - }, - "labelGroup": { - "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", - "type": "string" - }, - "languageCode": { - "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", - "type": "string" - }, - "questionDuration": { - "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", - "format": "google-duration", - "type": "string" - }, - "replicaCount": { - "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", - "format": "int32", - "type": "integer" - }, - "userEmailAddress": { - "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata": { - "description": "Metadata of an ImportData operation.", - "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata", - "properties": { - "createTime": { - "description": "Output only. Timestamp when import dataset request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", - "type": "string" - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse": { - "description": "Response used for ImportData longrunning operation.", - "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse", - "properties": { - "dataset": { - "description": "Ouptut only. The name of imported dataset.", - "type": "string" - }, - "importCount": { - "description": "Output only. Number of examples imported successfully.", - "format": "int32", - "type": "integer" - }, - "totalCount": { - "description": "Output only. Total number of examples requested to import", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata": { - "description": "Details of LabelImageBoundingPoly operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata": { - "description": "Metadata of a LabelImageClassification operation.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata": { - "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata": { - "description": "Details of LabelImagePolyline operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata": { - "description": "Details of a LabelImageSegmentation operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata": { - "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata", - "properties": { - "annotatedDataset": { - "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when labeling request was created.", - "format": "google-datetime", - "type": "string" - }, - "dataset": { - "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", - "type": "string" - }, - "imageBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", - "description": "Details of label image bounding box operation." - }, - "imageBoundingPolyDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", - "description": "Details of label image bounding poly operation." - }, - "imageClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", - "description": "Details of label image classification operation." - }, - "imageOrientedBoundingBoxDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", - "description": "Details of label image oriented bounding box operation." - }, - "imagePolylineDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", - "description": "Details of label image polyline operation." - }, - "imageSegmentationDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", - "description": "Details of label image segmentation operation." - }, - "partialFailures": { - "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "progressPercent": { - "description": "Output only. Progress of label operation. Range: [0, 100].", - "format": "int32", - "type": "integer" - }, - "textClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", - "description": "Details of label text classification operation." - }, - "textEntityExtractionDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata", - "description": "Details of label text entity extraction operation." - }, - "videoClassificationDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", - "description": "Details of label video classification operation." - }, - "videoEventDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", - "description": "Details of label video event operation." - }, - "videoObjectDetectionDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata", - "description": "Details of label video object detection operation." - }, - "videoObjectTrackingDetails": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", - "description": "Details of label video object tracking operation." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelStats": { - "description": "Statistics about annotation specs.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelStats", - "properties": { - "exampleCount": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata": { - "description": "Details of a LabelTextClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata": { - "description": "Details of a LabelTextEntityExtraction operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata": { - "description": "Details of a LabelVideoClassification operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata": { - "description": "Details of a LabelVideoEvent operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata": { - "description": "Details of a LabelVideoObjectDetection operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata": { - "description": "Details of a LabelVideoObjectTracking operation metadata.", - "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", - "properties": { - "basicConfig": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", - "description": "Basic human annotation config used in labeling request." - } - }, - "type": "object" - }, - "GoogleCloudDatalabelingV1p2alpha1OutputConfig": { - "description": "The configuration of output data.", - "id": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsDestination", - "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." - }, - "gcsFolderDestination": { - "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination", - "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." - } - }, - "type": "object" - }, - "GoogleLongrunningListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "GoogleLongrunningListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "GoogleLongrunningOperation" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleLongrunningOperation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "GoogleLongrunningOperation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleProtobufEmpty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "GoogleProtobufEmpty", - "properties": {}, - "type": "object" - }, - "GoogleRpcStatus": { - "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": "GoogleRpcStatus", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" + "name": { + "description": "Output only. The AnnotationSpecSet resource name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig": { + "description": "Annotation spec set with the setting of allowing multi labels or not.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig", + "properties": { + "allowMultiLabel": { + "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set.", + "type": "boolean" + }, + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationValue": { + "description": "Annotation value for an example.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationValue", + "properties": { + "imageBoundingPolyAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", + "description": "Annotation value for image bounding box, oriented bounding box and polygon cases." + }, + "imageClassificationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", + "description": "Annotation value for image classification case." + }, + "imagePolylineAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", + "description": "Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other." + }, + "imageSegmentationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation", + "description": "Annotation value for image segmentation." + }, + "textClassificationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", + "description": "Annotation value for text classification case." + }, + "textEntityExtractionAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", + "description": "Annotation value for text entity extraction case." + }, + "videoClassificationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", + "description": "Annotation value for video classification case." + }, + "videoEventAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation", + "description": "Annotation value for video event case." + }, + "videoObjectTrackingAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation", + "description": "Annotation value for video object detection and tracking case." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Attempt": { + "description": "Records a failed evaluation job run.", + "id": "GoogleCloudDatalabelingV1beta1Attempt", + "properties": { + "attemptTime": { + "format": "google-datetime", + "type": "string" + }, + "partialFailures": { + "description": "Details of errors that occurred.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BigQuerySource": { + "description": "The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version.", + "id": "GoogleCloudDatalabelingV1beta1BigQuerySource", + "properties": { + "inputUri": { + "description": "Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: \"bq://{your_project_id}/ {your_dataset_name}/{your_table_name}\" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions": { + "description": "Options regarding evaluation between bounding boxes.", + "id": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", + "properties": { + "iouThreshold": { + "description": "Minimum [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) required for 2 bounding boxes to be considered a match. This must be a number between 0 and 1.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BoundingPoly": { + "description": "A bounding polygon in the image.", + "id": "GoogleCloudDatalabelingV1beta1BoundingPoly", + "properties": { + "vertices": { + "description": "The bounding polygon vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Vertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BoundingPolyConfig": { + "description": "Config for image bounding poly (and bounding box) human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "instructionMessage": { + "description": "Optional. Instruction message showed on contributors UI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ClassificationMetadata": { + "description": "Metadata for classification annotations.", + "id": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", + "properties": { + "isMultiLabel": { + "description": "Whether the classification task is multi-label or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ClassificationMetrics": { + "description": "Metrics calculated for a classification model.", + "id": "GoogleCloudDatalabelingV1beta1ClassificationMetrics", + "properties": { + "confusionMatrix": { + "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrix", + "description": "Confusion matrix of predicted labels vs. ground truth labels." + }, + "prCurve": { + "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", + "description": "Precision-recall curve based on ground truth labels, predicted labels, and scores for the predicted labels." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry": { + "id": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Threshold used for this entry. For classification tasks, this is a classification threshold: a predicted label is categorized as positive or negative (in the context of this point on the PR curve) based on whether the label's score meets this threshold. For image object detection (bounding box) tasks, this is the [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) threshold for the context of this point on the PR curve.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "f1ScoreAt1": { + "description": "The harmonic mean of recall_at1 and precision_at1.", + "format": "float", + "type": "number" + }, + "f1ScoreAt5": { + "description": "The harmonic mean of recall_at5 and precision_at5.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision value.", + "format": "float", + "type": "number" + }, + "precisionAt1": { + "description": "Precision value for entries with label that has highest score.", + "format": "float", + "type": "number" + }, + "precisionAt5": { + "description": "Precision value for entries with label that has highest 5 scores.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall value.", + "format": "float", + "type": "number" + }, + "recallAt1": { + "description": "Recall value for entries with label that has highest score.", + "format": "float", + "type": "number" + }, + "recallAt5": { + "description": "Recall value for entries with label that has highest 5 scores.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ConfusionMatrix": { + "description": "Confusion matrix of the model running the classification. Only applicable when the metrics entry aggregates multiple labels. Not applicable when the entry is for a single label.", + "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrix", + "properties": { + "row": { + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry": { + "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "The annotation spec of a predicted label." + }, + "itemCount": { + "description": "Number of items predicted to have this label. (The ground truth label for these items is the `Row.annotationSpec` of this entry's parent.)", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest": { + "description": "Request message for CreateAnnotationSpecSet.", + "id": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest", + "properties": { + "annotationSpecSet": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", + "description": "Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateDatasetRequest": { + "description": "Request message for CreateDataset.", + "id": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest", + "properties": { + "dataset": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset", + "description": "Required. The dataset to be created." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest": { + "description": "Request message for CreateEvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest", + "properties": { + "job": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob", + "description": "Required. The evaluation job to create." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateInstructionRequest": { + "description": "Request message for CreateInstruction.", + "id": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest", + "properties": { + "instruction": { + "$ref": "GoogleCloudDatalabelingV1beta1Instruction", + "description": "Required. Instruction of how to perform the labeling task." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CsvInstruction": { + "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file.", + "id": "GoogleCloudDatalabelingV1beta1CsvInstruction", + "properties": { + "gcsFileUri": { + "description": "CSV file for the instruction. Only gcs path is allowed.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1DataItem": { + "description": "DataItem is a piece of data, without annotation. For example, an image.", + "id": "GoogleCloudDatalabelingV1beta1DataItem", + "properties": { + "imagePayload": { + "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload", + "description": "The image payload, a container of the image bytes/uri." + }, + "name": { + "description": "Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", + "type": "string" + }, + "textPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", + "description": "The text payload, a container of text content." + }, + "videoPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload", + "description": "The video payload, a container of the video uri." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Dataset": { + "description": "Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.", + "id": "GoogleCloudDatalabelingV1beta1Dataset", + "properties": { + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the dataset.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Time the dataset is created.", + "format": "google-datetime", + "type": "string" + }, + "dataItemCount": { + "description": "Output only. The number of data items in the dataset.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the dataset. Maximum of 64 characters.", + "type": "string" + }, + "inputConfigs": { + "description": "Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1InputConfig" + }, + "type": "array" + }, + "lastMigrateTime": { + "description": "Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Evaluation": { + "description": "Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.", + "id": "GoogleCloudDatalabelingV1beta1Evaluation", + "properties": { + "annotationType": { + "description": "Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.", + "enum": [ + "ANNOTATION_TYPE_UNSPECIFIED", + "IMAGE_CLASSIFICATION_ANNOTATION", + "IMAGE_BOUNDING_BOX_ANNOTATION", + "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", + "IMAGE_BOUNDING_POLY_ANNOTATION", + "IMAGE_POLYLINE_ANNOTATION", + "IMAGE_SEGMENTATION_ANNOTATION", + "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", + "VIDEO_OBJECT_TRACKING_ANNOTATION", + "VIDEO_OBJECT_DETECTION_ANNOTATION", + "VIDEO_EVENT_ANNOTATION", + "TEXT_CLASSIFICATION_ANNOTATION", + "TEXT_ENTITY_EXTRACTION_ANNOTATION", + "GENERAL_CLASSIFICATION_ANNOTATION" + ], + "enumDescriptions": [ + "", + "Classification annotations in an image. Allowed for continuous evaluation.", + "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", + "Oriented bounding box. The box does not have to be parallel to horizontal line.", + "Bounding poly annotations in an image.", + "Polyline annotations in an image.", + "Segmentation annotations in an image.", + "Classification annotations in video shots.", + "Video object tracking annotation.", + "Video object detection annotation.", + "Video event annotation.", + "Classification for text. Allowed for continuous evaluation.", + "Entity extraction for text.", + "General classification. Allowed for continuous evaluation." + ], + "type": "string" + }, + "config": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig", + "description": "Output only. Options used in the evaluation job that created this evaluation." + }, + "createTime": { + "description": "Output only. Timestamp for when this evaluation was created.", + "format": "google-datetime", + "type": "string" + }, + "evaluatedItemCount": { + "description": "Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes.", + "format": "int64", + "type": "string" + }, + "evaluationJobRunTime": { + "description": "Output only. Timestamp for when the evaluation job that created this evaluation ran.", + "format": "google-datetime", + "type": "string" + }, + "evaluationMetrics": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", + "description": "Output only. Metrics comparing predictions to ground truth labels." + }, + "name": { + "description": "Output only. Resource name of an evaluation. The name has the following format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}'", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationConfig": { + "description": "Configuration details used for calculating evaluation metrics and creating an Evaluation.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationConfig", + "properties": { + "boundingBoxEvaluationOptions": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", + "description": "Only specify this field if the related model performs image object detection (`IMAGE_BOUNDING_BOX_ANNOTATION`). Describes how to evaluate bounding boxes." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationJob": { + "description": "Defines an evaluation job that runs periodically to generate Evaluations. [Creating an evaluation job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point for using continuous evaluation.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationJob", + "properties": { + "annotationSpecSet": { + "description": "Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", + "type": "string" + }, + "attempts": { + "description": "Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Attempt" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Timestamp of when this evaluation job was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Required. Description of the job. The description can be up to 25,000 characters long.", + "type": "string" + }, + "evaluationJobConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", + "description": "Required. Configuration details for the evaluation job." + }, + "labelMissingGroundTruth": { + "description": "Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`.", + "type": "boolean" + }, + "modelVersion": { + "description": "Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: \"projects/{project_id}/models/{model_name}/versions/{version_name}\" There can only be one evaluation job per model version.", + "type": "string" + }, + "name": { + "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"", + "type": "string" + }, + "schedule": { + "description": "Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in [crontab format](/scheduler/docs/configuring/cron-job-schedules) or in an [English-like format](/appengine/docs/standard/python/config/cronref#schedule_format). Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day.", + "type": "string" + }, + "state": { + "description": "Output only. Describes the current state of the job.", + "enum": [ + "STATE_UNSPECIFIED", + "SCHEDULED", + "RUNNING", + "PAUSED", + "STOPPED" + ], + "enumDescriptions": [ + "", + "The job is scheduled to run at the configured interval. You can pause or delete the job. When the job is in this state, it samples prediction input and output from your model version into your BigQuery table as predictions occur.", + "The job is currently running. When the job runs, Data Labeling Service does several things: 1. If you have configured your job to use Data Labeling Service for ground truth labeling, the service creates a Dataset and a labeling task for all data sampled since the last time the job ran. Human labelers provide ground truth labels for your data. Human labeling may take hours, or even days, depending on how much data has been sampled. The job remains in the `RUNNING` state during this time, and it can even be running multiple times in parallel if it gets triggered again (for example 24 hours later) before the earlier run has completed. When human labelers have finished labeling the data, the next step occurs. If you have configured your job to provide your own ground truth labels, Data Labeling Service still creates a Dataset for newly sampled data, but it expects that you have already added ground truth labels to the BigQuery table by this time. The next step occurs immediately. 2. Data Labeling Service creates an Evaluation by comparing your model version's predictions with the ground truth labels. If the job remains in this state for a long time, it continues to sample prediction data into your BigQuery table and will run again at the next interval, even if it causes the job to run multiple times in parallel.", + "The job is not sampling prediction input and output into your BigQuery table and it will not run according to its schedule. You can resume the job.", + "The job has this state right before it is deleted." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig": { + "description": "Provides details for how an evaluation job sends email alerts based on the results of a run.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", + "properties": { + "email": { + "description": "Required. An email address to send alerts to.", + "type": "string" + }, + "minAcceptableMeanAveragePrecision": { + "description": "Required. A number between 0 and 1 that describes a minimum mean average precision threshold. When the evaluation job runs, if it calculates that your model version's predictions from the recent interval have meanAveragePrecision below this threshold, then it sends an alert to your specified email.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationJobConfig": { + "description": "Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", + "properties": { + "bigqueryImportKeys": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON. You can provide the following entries in this field: * `data_json_key`: the data key for prediction input. You must provide either this key or `reference_json_key`. * `reference_json_key`: the data reference key for prediction input. You must provide either this key or `data_json_key`. * `label_json_key`: the label key for prediction output. Required. * `label_score_json_key`: the score key for prediction output. Required. * `bounding_box_json_key`: the bounding box key for prediction output. Required if your model version perform image object detection. Learn [how to configure prediction keys](/ml-engine/docs/continuous-evaluation/create-job#prediction-keys).", + "type": "object" + }, + "boundingPolyConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "description": "Specify this field if your model version performs image object detection (bounding box detection). `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet." + }, + "evaluationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig", + "description": "Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the `boundingBoxEvaluationOptions` field within this configuration. Otherwise, provide an empty object for this configuration." + }, + "evaluationJobAlertConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", + "description": "Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run." + }, + "exampleCount": { + "description": "Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides `example_sample_percentage`: even if the service has not sampled enough predictions to fulfill `example_sample_perecentage` during an interval, it stops sampling predictions when it meets this limit.", + "format": "int32", + "type": "integer" + }, + "exampleSamplePercentage": { + "description": "Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.", + "format": "double", + "type": "number" + }, + "humanAnnotationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to `true` for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field. Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the `instruction` field within this configuration." + }, + "imageClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "description": "Specify this field if your model version performs image classification or general classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config." + }, + "inputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1InputConfig", + "description": "Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields: * `dataType` must be one of `IMAGE`, `TEXT`, or `GENERAL_DATA`. * `annotationType` must be one of `IMAGE_CLASSIFICATION_ANNOTATION`, `TEXT_CLASSIFICATION_ANNOTATION`, `GENERAL_CLASSIFICATION_ANNOTATION`, or `IMAGE_BOUNDING_BOX_ANNOTATION` (image object detection). * If your machine learning model performs classification, you must specify `classificationMetadata.isMultiLabel`. * You must specify `bigquerySource` (not `gcsSource`)." + }, + "textClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "description": "Specify this field if your model version performs text classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationMetrics": { + "id": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", + "properties": { + "classificationMetrics": { + "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetrics" + }, + "objectDetectionMetrics": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EventConfig": { + "description": "Config for video event human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1EventConfig", + "properties": { + "annotationSpecSets": { + "description": "Required. The list of annotation spec set resource name. Similar to video classification, we support selecting event from multiple AnnotationSpecSet at the same time.", + "items": { + "type": "string" + }, + "type": "array" + }, + "clipLength": { + "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 60s.", + "format": "int32", + "type": "integer" + }, + "overlapLength": { + "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 1s.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Example": { + "description": "An Example is a piece of data and its annotation. For example, an image with label \"house\".", + "id": "GoogleCloudDatalabelingV1beta1Example", + "properties": { + "annotations": { + "description": "Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Annotation" + }, + "type": "array" + }, + "imagePayload": { + "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload", + "description": "The image payload, a container of the image bytes/uri." + }, + "name": { + "description": "Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", + "type": "string" + }, + "textPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", + "description": "The text payload, a container of the text content." + }, + "videoPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload", + "description": "The video payload, a container of the video uri." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExampleComparison": { + "description": "Example comparisons comparing ground truth output and predictions for a specific input.", + "id": "GoogleCloudDatalabelingV1beta1ExampleComparison", + "properties": { + "groundTruthExample": { + "$ref": "GoogleCloudDatalabelingV1beta1Example", + "description": "The ground truth output for the input." + }, + "modelCreatedExamples": { + "description": "Predictions by the model for the input.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Example" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExportDataRequest": { + "description": "Request message for ExportData API.", + "id": "GoogleCloudDatalabelingV1beta1ExportDataRequest", + "properties": { + "annotatedDataset": { + "description": "Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "type": "string" + }, + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", + "description": "Required. Specify the output destination." + }, + "userEmailAddress": { + "description": "Email of the user who started the export task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1FeedbackMessage": { + "description": "A feedback message inside a feedback thread.", + "id": "GoogleCloudDatalabelingV1beta1FeedbackMessage", + "properties": { + "body": { + "description": "String content of the feedback. Maximum of 10000 characters.", + "type": "string" + }, + "createTime": { + "description": "Create time.", + "format": "google-datetime", + "type": "string" + }, + "image": { + "description": "The image storing this feedback if the feedback is an image representing operator's comments.", + "format": "byte", + "type": "string" + }, + "name": { + "description": "Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}'", + "type": "string" + }, + "operatorFeedbackMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata" + }, + "requesterFeedbackMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1FeedbackThread": { + "description": "A feedback thread of a certain labeling task on a certain annotated dataset.", + "id": "GoogleCloudDatalabelingV1beta1FeedbackThread", + "properties": { + "feedbackThreadMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", + "description": "Metadata regarding the feedback thread." + }, + "name": { + "description": "Name of the feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata": { + "id": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", + "properties": { + "createTime": { + "description": "When the thread is created", + "format": "google-datetime", + "type": "string" + }, + "lastUpdateTime": { + "description": "When the thread is last updated.", + "format": "google-datetime", + "type": "string" + }, + "status": { + "enum": [ + "FEEDBACK_THREAD_STATUS_UNSPECIFIED", + "NEW", + "REPLIED" + ], + "enumDescriptions": [ + "", + "Feedback thread is created with no reply;", + "Feedback thread is replied at least once;" + ], + "type": "string" + }, + "thumbnail": { + "description": "An image thumbnail of this thread.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1beta1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1GcsSource": { + "description": "Source of the Cloud Storage file to be imported.", + "id": "GoogleCloudDatalabelingV1beta1GcsSource", + "properties": { + "inputUri": { + "description": "Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).", + "type": "string" + }, + "mimeType": { + "description": "Required. The format of the source file. Only \"text/csv\" is supported.", + "type": "string" } + }, + "type": "object" }, - "servicePath": "", - "title": "Data Labeling API", - "version": "v1beta1", - "version_module": true + "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation": { + "description": "Image bounding poly annotation. It represents a polygon including bounding box in the image.", + "id": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of object in this bounding polygon." + }, + "boundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" + }, + "normalizedBoundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation": { + "description": "Image classification annotation definition.", + "id": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of image." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageClassificationConfig": { + "description": "Config for image classification human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "properties": { + "allowMultiLabel": { + "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image.", + "type": "boolean" + }, + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "answerAggregationType": { + "description": "Optional. The type of how to aggregate answers.", + "enum": [ + "STRING_AGGREGATION_TYPE_UNSPECIFIED", + "MAJORITY_VOTE", + "UNANIMOUS_VOTE", + "NO_AGGREGATION" + ], + "enumDescriptions": [ + "", + "Majority vote to aggregate answers.", + "Unanimous answers will be adopted.", + "Preserve all answers by crowd compute." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImagePayload": { + "description": "Container of information about an image.", + "id": "GoogleCloudDatalabelingV1beta1ImagePayload", + "properties": { + "imageThumbnail": { + "description": "A byte string of a thumbnail image.", + "format": "byte", + "type": "string" + }, + "imageUri": { + "description": "Image uri from the user bucket.", + "type": "string" + }, + "mimeType": { + "description": "Image format.", + "type": "string" + }, + "signedUri": { + "description": "Signed uri of the image file in the service bucket.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation": { + "description": "A polyline for the image annotation.", + "id": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of this polyline." + }, + "normalizedPolyline": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedPolyline" + }, + "polyline": { + "$ref": "GoogleCloudDatalabelingV1beta1Polyline" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation": { + "description": "Image segmentation annotation.", + "id": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation", + "properties": { + "annotationColors": { + "additionalProperties": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" + }, + "description": "The mapping between rgb color and annotation spec. The key is the rgb color represented in format of rgb(0, 0, 0). The value is the AnnotationSpec.", + "type": "object" + }, + "imageBytes": { + "description": "A byte string of a full image's color map.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "Image format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImportDataRequest": { + "description": "Request message for ImportData API.", + "id": "GoogleCloudDatalabelingV1beta1ImportDataRequest", + "properties": { + "inputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1InputConfig", + "description": "Required. Specify the input source of the data." + }, + "userEmailAddress": { + "description": "Email of the user who started the import task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1InputConfig": { + "description": "The configuration of input data, including data type, location, etc.", + "id": "GoogleCloudDatalabelingV1beta1InputConfig", + "properties": { + "annotationType": { + "description": "Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.", + "enum": [ + "ANNOTATION_TYPE_UNSPECIFIED", + "IMAGE_CLASSIFICATION_ANNOTATION", + "IMAGE_BOUNDING_BOX_ANNOTATION", + "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", + "IMAGE_BOUNDING_POLY_ANNOTATION", + "IMAGE_POLYLINE_ANNOTATION", + "IMAGE_SEGMENTATION_ANNOTATION", + "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", + "VIDEO_OBJECT_TRACKING_ANNOTATION", + "VIDEO_OBJECT_DETECTION_ANNOTATION", + "VIDEO_EVENT_ANNOTATION", + "TEXT_CLASSIFICATION_ANNOTATION", + "TEXT_ENTITY_EXTRACTION_ANNOTATION", + "GENERAL_CLASSIFICATION_ANNOTATION" + ], + "enumDescriptions": [ + "", + "Classification annotations in an image. Allowed for continuous evaluation.", + "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", + "Oriented bounding box. The box does not have to be parallel to horizontal line.", + "Bounding poly annotations in an image.", + "Polyline annotations in an image.", + "Segmentation annotations in an image.", + "Classification annotations in video shots.", + "Video object tracking annotation.", + "Video object detection annotation.", + "Video event annotation.", + "Classification for text. Allowed for continuous evaluation.", + "Entity extraction for text.", + "General classification. Allowed for continuous evaluation." + ], + "type": "string" + }, + "bigquerySource": { + "$ref": "GoogleCloudDatalabelingV1beta1BigQuerySource", + "description": "Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob." + }, + "classificationMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", + "description": "Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification." + }, + "dataType": { + "description": "Required. Data type must be specifed when user tries to import data.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "IMAGE", + "VIDEO", + "TEXT", + "GENERAL_DATA" + ], + "enumDescriptions": [ + "Data type is unspecified.", + "Allowed for continuous evaluation.", + "Video data type.", + "Allowed for continuous evaluation.", + "Allowed for continuous evaluation." + ], + "type": "string" + }, + "gcsSource": { + "$ref": "GoogleCloudDatalabelingV1beta1GcsSource", + "description": "Source located in Cloud Storage." + }, + "textMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1TextMetadata", + "description": "Required for text import, as language code must be specified." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Instruction": { + "description": "Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.", + "id": "GoogleCloudDatalabelingV1beta1Instruction", + "properties": { + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the instruction.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Creation time of instruction.", + "format": "google-datetime", + "type": "string" + }, + "csvInstruction": { + "$ref": "GoogleCloudDatalabelingV1beta1CsvInstruction", + "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data." + }, + "dataType": { + "description": "Required. The data type of this instruction.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "IMAGE", + "VIDEO", + "TEXT", + "GENERAL_DATA" + ], + "enumDescriptions": [ + "Data type is unspecified.", + "Allowed for continuous evaluation.", + "Video data type.", + "Allowed for continuous evaluation.", + "Allowed for continuous evaluation." + ], + "type": "string" + }, + "description": { + "description": "Optional. User-provided description of the instruction. The description can be up to 10000 characters long.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the instruction. Maximum of 64 characters.", + "type": "string" + }, + "name": { + "description": "Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "pdfInstruction": { + "$ref": "GoogleCloudDatalabelingV1beta1PdfInstruction", + "description": "Instruction from a PDF document. The PDF should be in a Cloud Storage bucket." + }, + "updateTime": { + "description": "Output only. Last update time of instruction.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageRequest": { + "description": "Request message for starting an image labeling task.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageRequest", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Required. Basic human annotation config." + }, + "boundingPolyConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "description": "Configuration for bounding box and bounding poly task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + }, + "feature": { + "description": "Required. The type of image labeling task.", + "enum": [ + "FEATURE_UNSPECIFIED", + "CLASSIFICATION", + "BOUNDING_BOX", + "ORIENTED_BOUNDING_BOX", + "BOUNDING_POLY", + "POLYLINE", + "SEGMENTATION" + ], + "enumDescriptions": [ + "", + "Label whole image with one or more of labels.", + "Label image with bounding boxes for labels.", + "Label oriented bounding box. The box does not have to be parallel to horizontal line.", + "Label images with bounding poly. A bounding poly is a plane figure that is bounded by a finite chain of straight line segments closing in a loop.", + "Label images with polyline. Polyline is formed by connected line segments which are not in closed form.", + "Label images with segmentation. Segmentation is different from bounding poly since it is more fine-grained, pixel level annotation." + ], + "type": "string" + }, + "imageClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "description": "Configuration for image classification task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + }, + "polylineConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", + "description": "Configuration for polyline task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + }, + "segmentationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", + "description": "Configuration for segmentation task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1beta1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1beta1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelTextRequest": { + "description": "Request message for LabelText.", + "id": "GoogleCloudDatalabelingV1beta1LabelTextRequest", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Required. Basic human annotation config." + }, + "feature": { + "description": "Required. The type of text labeling task.", + "enum": [ + "FEATURE_UNSPECIFIED", + "TEXT_CLASSIFICATION", + "TEXT_ENTITY_EXTRACTION" + ], + "enumDescriptions": [ + "", + "Label text content to one of more labels.", + "Label entities and their span in text." + ], + "type": "string" + }, + "textClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "description": "Configuration for text classification task. One of text_classification_config and text_entity_extraction_config is required." + }, + "textEntityExtractionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", + "description": "Configuration for entity extraction task. One of text_classification_config and text_entity_extraction_config is required." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoRequest": { + "description": "Request message for LabelVideo.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoRequest", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Required. Basic human annotation config." + }, + "eventConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", + "description": "Configuration for video event task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + }, + "feature": { + "description": "Required. The type of video labeling task.", + "enum": [ + "FEATURE_UNSPECIFIED", + "CLASSIFICATION", + "OBJECT_DETECTION", + "OBJECT_TRACKING", + "EVENT" + ], + "enumDescriptions": [ + "", + "Label whole video or video segment with one or more labels.", + "Label objects with bounding box on image frames extracted from the video.", + "Label and track objects in video.", + "Label the range of video for the specified events." + ], + "type": "string" + }, + "objectDetectionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", + "description": "Configuration for video object detection task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + }, + "objectTrackingConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", + "description": "Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + }, + "videoClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", + "description": "Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse": { + "description": "Results of listing annotated datasets for a dataset.", + "id": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse", + "properties": { + "annotatedDatasets": { + "description": "The list of annotated datasets to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse": { + "description": "Results of listing annotation spec set under a project.", + "id": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse", + "properties": { + "annotationSpecSets": { + "description": "The list of annotation spec sets.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListDataItemsResponse": { + "description": "Results of listing data items in a dataset.", + "id": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse", + "properties": { + "dataItems": { + "description": "The list of data items to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1DataItem" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListDatasetsResponse": { + "description": "Results of listing datasets within a project.", + "id": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse", + "properties": { + "datasets": { + "description": "The list of datasets to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse": { + "description": "Results for listing evaluation jobs.", + "id": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse", + "properties": { + "evaluationJobs": { + "description": "The list of evaluation jobs to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListExamplesResponse": { + "description": "Results of listing Examples in and annotated dataset.", + "id": "GoogleCloudDatalabelingV1beta1ListExamplesResponse", + "properties": { + "examples": { + "description": "The list of examples to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Example" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse": { + "description": "Results for listing FeedbackMessages.", + "id": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse", + "properties": { + "feedbackMessages": { + "description": "The list of feedback messages to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse": { + "description": "Results for listing FeedbackThreads.", + "id": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse", + "properties": { + "feedbackThreads": { + "description": "The list of feedback threads to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListInstructionsResponse": { + "description": "Results of listing instructions under a project.", + "id": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse", + "properties": { + "instructions": { + "description": "The list of Instructions to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Instruction" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly": { + "description": "Normalized bounding polygon.", + "id": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly", + "properties": { + "normalizedVertices": { + "description": "The bounding polygon normalized vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1NormalizedPolyline": { + "description": "Normalized polyline.", + "id": "GoogleCloudDatalabelingV1beta1NormalizedPolyline", + "properties": { + "normalizedVertices": { + "description": "The normalized polyline vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1NormalizedVertex": { + "description": "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.", + "id": "GoogleCloudDatalabelingV1beta1NormalizedVertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "float", + "type": "number" + }, + "y": { + "description": "Y coordinate.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig": { + "description": "Config for video object detection human labeling task. Object detection will be conducted on the images extracted from the video, and those objects will be labeled with bounding boxes. User need to specify the number of images to be extracted per second as the extraction frame rate.", + "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "extractionFrameRate": { + "description": "Required. Number of frames per second to be extracted from the video.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics": { + "description": "Metrics calculated for an image object detection (bounding box) model.", + "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics", + "properties": { + "prCurve": { + "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", + "description": "Precision-recall curve." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig": { + "description": "Config for video object tracking human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "clipLength": { + "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 20s.", + "format": "int32", + "type": "integer" + }, + "overlapLength": { + "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 0.3s.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame": { + "description": "Video frame level annotation for object detection and tracking.", + "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame", + "properties": { + "boundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" + }, + "normalizedBoundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" + }, + "timeOffset": { + "description": "The time offset of this frame relative to the beginning of the video.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata": { + "description": "Metadata describing the feedback from the operator.", + "id": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1OperatorMetadata": { + "description": "General information useful for labels coming from contributors.", + "id": "GoogleCloudDatalabelingV1beta1OperatorMetadata", + "properties": { + "comments": { + "description": "Comments from contributors.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labelVotes": { + "description": "The total number of contributors that choose this label.", + "format": "int32", + "type": "integer" + }, + "score": { + "description": "Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).", + "format": "float", + "type": "number" + }, + "totalVotes": { + "description": "The total number of contributors that answer this question.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1beta1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1beta1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest": { + "description": "Request message for PauseEvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PdfInstruction": { + "description": "Instruction from a PDF file.", + "id": "GoogleCloudDatalabelingV1beta1PdfInstruction", + "properties": { + "gcsFileUri": { + "description": "PDF file for the instruction. Only gcs path is allowed.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Polyline": { + "description": "A line with multiple line segments.", + "id": "GoogleCloudDatalabelingV1beta1Polyline", + "properties": { + "vertices": { + "description": "The polyline vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Vertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PolylineConfig": { + "description": "Config for image polyline human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1PolylineConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "instructionMessage": { + "description": "Optional. Instruction message showed on contributors UI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PrCurve": { + "id": "GoogleCloudDatalabelingV1beta1PrCurve", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "The annotation spec of the label for which the precision-recall curve calculated. If this field is empty, that means the precision-recall curve is an aggregate curve for all labels." + }, + "areaUnderCurve": { + "description": "Area under the precision-recall curve. Not to be confused with area under a receiver operating characteristic (ROC) curve.", + "format": "float", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Entries that make up the precision-recall graph. Each entry is a \"point\" on the graph drawn for a different `confidence_threshold`.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry" + }, + "type": "array" + }, + "meanAveragePrecision": { + "description": "Mean average prcision of this curve.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata": { + "description": "Metadata describing the feedback from the labeling task requester.", + "id": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest": { + "description": "Request message ResumeEvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Row": { + "description": "A row in the confusion matrix. Each entry in this row has the same ground truth label.", + "id": "GoogleCloudDatalabelingV1beta1Row", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "The annotation spec of the ground truth label for this row." + }, + "entries": { + "description": "A list of the confusion matrix entries. One entry for each possible predicted label.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse": { + "description": "Results of searching evaluations.", + "id": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse", + "properties": { + "evaluations": { + "description": "The list of evaluations matching the search.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest": { + "description": "Request message of SearchExampleComparisons.", + "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest", + "properties": { + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest. If you don't specify this field, the API call requests the first page of the search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse": { + "description": "Results of searching example comparisons.", + "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse", + "properties": { + "exampleComparisons": { + "description": "A list of example comparisons matching the search criteria.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ExampleComparison" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SegmentationConfig": { + "description": "Config for image segmentation", + "id": "GoogleCloudDatalabelingV1beta1SegmentationConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name. format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", + "type": "string" + }, + "instructionMessage": { + "description": "Instruction message showed on labelers UI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SentimentConfig": { + "description": "Config for setting up sentiments.", + "id": "GoogleCloudDatalabelingV1beta1SentimentConfig", + "properties": { + "enableLabelSentimentSelection": { + "description": "If set to true, contributors will have the option to select sentiment of the label they selected, to mark it as negative or positive label. Default is false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SequentialSegment": { + "description": "Start and end position in a sequence (e.g. text segment).", + "id": "GoogleCloudDatalabelingV1beta1SequentialSegment", + "properties": { + "end": { + "description": "End position (exclusive).", + "format": "int32", + "type": "integer" + }, + "start": { + "description": "Start position (inclusive).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation": { + "description": "Text classification annotation.", + "id": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the text." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextClassificationConfig": { + "description": "Config for text classification human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "properties": { + "allowMultiLabel": { + "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one text segment.", + "type": "boolean" + }, + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "sentimentConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1SentimentConfig", + "description": "Optional. Configs for sentiment selection. We deprecate sentiment analysis in data labeling side as it is incompatible with uCAIP." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation": { + "description": "Text entity extraction annotation.", + "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the text entities." + }, + "sequentialSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1SequentialSegment", + "description": "Position of the entity." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig": { + "description": "Config for text entity extraction human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextMetadata": { + "description": "Metadata for the text.", + "id": "GoogleCloudDatalabelingV1beta1TextMetadata", + "properties": { + "languageCode": { + "description": "The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextPayload": { + "description": "Container of information about a piece of text.", + "id": "GoogleCloudDatalabelingV1beta1TextPayload", + "properties": { + "textContent": { + "description": "Text content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TimeSegment": { + "description": "A time period inside of an example that has a time dimension (e.g. video).", + "id": "GoogleCloudDatalabelingV1beta1TimeSegment", + "properties": { + "endTimeOffset": { + "description": "End of the time segment (exclusive), represented as the duration since the example start.", + "format": "google-duration", + "type": "string" + }, + "startTimeOffset": { + "description": "Start of the time segment (inclusive), represented as the duration since the example start.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Vertex": { + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", + "id": "GoogleCloudDatalabelingV1beta1Vertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "int32", + "type": "integer" + }, + "y": { + "description": "Y coordinate.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation": { + "description": "Video classification annotation.", + "id": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the segment specified by time_segment." + }, + "timeSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", + "description": "The time segment of the video to which the annotation applies." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoClassificationConfig": { + "description": "Config for video classification human labeling task. Currently two types of video classification are supported: 1. Assign labels on the entire video. 2. Split the video into multiple video clips based on camera shot, and assign labels on each video clip.", + "id": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", + "properties": { + "annotationSpecSetConfigs": { + "description": "Required. The list of annotation spec set configs. Since watching a video clip takes much longer time than an image, we support label with multiple AnnotationSpecSet at the same time. Labels in each AnnotationSpecSet will be shown in a group to contributors. Contributors can select one or more (depending on whether to allow multi label) from each group.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig" + }, + "type": "array" + }, + "applyShotDetection": { + "description": "Optional. Option to apply shot detection on the video.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoEventAnnotation": { + "description": "Video event annotation.", + "id": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the event in this annotation." + }, + "timeSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", + "description": "The time segment of the video to which the annotation applies." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation": { + "description": "Video object tracking annotation.", + "id": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the object tracked in this annotation." + }, + "objectTrackingFrames": { + "description": "The list of frames where this object track appears.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame" + }, + "type": "array" + }, + "timeSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", + "description": "The time segment of the video to which object tracking applies." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoPayload": { + "description": "Container of information of a video.", + "id": "GoogleCloudDatalabelingV1beta1VideoPayload", + "properties": { + "frameRate": { + "description": "FPS of the video.", + "format": "float", + "type": "number" + }, + "mimeType": { + "description": "Video format.", + "type": "string" + }, + "signedUri": { + "description": "Signed uri of the video file in the service bucket.", + "type": "string" + }, + "videoThumbnails": { + "description": "The list of video thumbnails.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoThumbnail" + }, + "type": "array" + }, + "videoUri": { + "description": "Video uri from the user bucket.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoThumbnail": { + "description": "Container of information of a video thumbnail.", + "id": "GoogleCloudDatalabelingV1beta1VideoThumbnail", + "properties": { + "thumbnail": { + "description": "A byte string of the video frame.", + "format": "byte", + "type": "string" + }, + "timeOffset": { + "description": "Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1p1alpha1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata": { + "description": "Metadata of an GenerateAnalysisReport operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata", + "properties": { + "createTime": { + "description": "Timestamp when generate report request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "The name of the dataset for which the analysis report is generated. Format: \"projects/*/datasets/*\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1p1alpha1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1p2alpha1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "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": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Data Labeling API", + "version": "v1beta1", + "version_module": true } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 16707710592..100e13cb6f2 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1049,7 +1049,7 @@ } } }, - "revision": "20210317", + "revision": "20210413", "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 86e96d52a1c..e54f8a29eff 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1049,7 +1049,7 @@ } } }, - "revision": "20210317", + "revision": "20210413", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index 9d0375d31e2..1d82d5f3cc1 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -625,7 +625,7 @@ } } }, - "revision": "20210326", + "revision": "20210419", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "AllocateIdsRequest": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json index 5177209699d..53e1897e5b7 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20210326", + "revision": "20210419", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "GoogleDatastoreAdminV1CommonMetadata": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json index a019ec57047..428e65ae744 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json @@ -307,7 +307,7 @@ } } }, - "revision": "20210326", + "revision": "20210419", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "AllocateIdsRequest": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index 85418edca0e..ae730eb06e5 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1588,7 +1588,7 @@ } } }, - "revision": "20210401", + "revision": "20210422", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index d8e7727a817..23404c710f7 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -988,7 +988,7 @@ } } }, - "revision": "20210401", + "revision": "20210422", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json index 48825317a21..f3aa7e7e61a 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1552,7 +1552,7 @@ } } }, - "revision": "20210401", + "revision": "20210422", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 68158699ccc..643620a111f 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -421,7 +421,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`.", + "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.", "location": "path", "pattern": "^projects/[^/]+/agent/fulfillment$", "required": true, @@ -778,6 +778,129 @@ }, "environments": { "methods": { + "create": { + "description": "Creates an agent environment.", + "flatPath": "v2/projects/{projectsId}/agent/environments", + "httpMethod": "POST", + "id": "dialogflow.projects.agent.environments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "environmentId": { + "description": "Required. The unique id of the new environment.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/environments", + "request": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified agent environment.", + "flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.agent.environments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent environment.", + "flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.environments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "getHistory": { + "description": "Gets the history of the specified environment.", + "flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}/history", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.environments.getHistory", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/history", + "response": { + "$ref": "GoogleCloudDialogflowV2EnvironmentHistory" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all non-draft environments of the specified agent.", "flatPath": "v2/projects/{projectsId}/agent/environments", @@ -799,7 +922,7 @@ "type": "string" }, "parent": { - "description": "Required. The agent to list all environments from. Format: `projects//agent`.", + "description": "Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`", "location": "path", "pattern": "^projects/[^/]+/agent$", "required": true, @@ -814,6 +937,46 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] + }, + "patch": { + "description": "Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use \"-\" as Environment ID in environment name to update version in \"draft\" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.", + "flatPath": "v2/projects/{projectsId}/agent/environments/{environmentsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.agent.environments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowLoadToDraftAndDiscardChanges": { + "description": "Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] } }, "resources": { @@ -2268,6 +2431,163 @@ } } } + }, + "versions": { + "methods": { + "create": { + "description": "Creates an agent version. The new version points to the agent instance in the \"default\" environment.", + "flatPath": "v2/projects/{projectsId}/agent/versions", + "httpMethod": "POST", + "id": "dialogflow.projects.agent.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/versions", + "request": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Delete the specified agent version.", + "flatPath": "v2/projects/{projectsId}/agent/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.agent.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent version.", + "flatPath": "v2/projects/{projectsId}/agent/versions/{versionsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all versions of the specified agent.", + "flatPath": "v2/projects/{projectsId}/agent/versions", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/versions", + "response": { + "$ref": "GoogleCloudDialogflowV2ListVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.", + "flatPath": "v2/projects/{projectsId}/agent/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.agent.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } } } }, @@ -3579,7 +3899,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`.", + "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agent/fulfillment$", "required": true, @@ -3936,6 +4256,129 @@ }, "environments": { "methods": { + "create": { + "description": "Creates an agent environment.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/environments", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agent.environments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "environmentId": { + "description": "Required. The unique id of the new environment.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/environments", + "request": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified agent environment.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agent.environments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent environment.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.environments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "getHistory": { + "description": "Gets the history of the specified environment.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/history", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.environments.getHistory", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/history", + "response": { + "$ref": "GoogleCloudDialogflowV2EnvironmentHistory" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all non-draft environments of the specified agent.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/environments", @@ -3957,7 +4400,7 @@ "type": "string" }, "parent": { - "description": "Required. The agent to list all environments from. Format: `projects//agent`.", + "description": "Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "required": true, @@ -3972,6 +4415,46 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] + }, + "patch": { + "description": "Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use \"-\" as Environment ID in environment name to update version in \"draft\" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agent.environments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowLoadToDraftAndDiscardChanges": { + "description": "Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] } }, "resources": { @@ -4979,42 +5462,199 @@ "https://www.googleapis.com/auth/dialogflow" ] }, - "patch": { - "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.sessions.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] + "patch": { + "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agent.sessions.entityTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "versions": { + "methods": { + "create": { + "description": "Creates an agent version. The new version points to the agent instance in the \"default\" environment.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/versions", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agent.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/versions", + "request": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Delete the specified agent version.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agent.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent version.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all versions of the specified agent.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/versions", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent$", + "required": true, + "type": "string" } - } + }, + "path": "v2/{+parent}/versions", + "response": { + "$ref": "GoogleCloudDialogflowV2ListVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agent.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] } } } @@ -6216,7 +6856,7 @@ } } }, - "revision": "20210412", + "revision": "20210426", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -6454,6 +7094,22 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportFlowResponse": { + "description": "The response message for Flows.ExportFlow.", + "id": "GoogleCloudDialogflowCxV3ExportFlowResponse", + "properties": { + "flowContent": { + "description": "Uncompressed raw byte content for flow.", + "format": "byte", + "type": "string" + }, + "flowUri": { + "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", @@ -6690,6 +7346,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportFlowResponse": { + "description": "The response message for Flows.ImportFlow.", + "id": "GoogleCloudDialogflowCxV3ImportFlowResponse", + "properties": { + "flow": { + "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -6794,7 +7461,7 @@ "id": "GoogleCloudDialogflowCxV3Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -6809,7 +7476,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -7510,6 +8177,10 @@ "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { @@ -7924,6 +8595,22 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportFlowResponse": { + "description": "The response message for Flows.ExportFlow.", + "id": "GoogleCloudDialogflowCxV3beta1ExportFlowResponse", + "properties": { + "flowContent": { + "description": "Uncompressed raw byte content for flow.", + "format": "byte", + "type": "string" + }, + "flowUri": { + "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -8160,6 +8847,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportFlowResponse": { + "description": "The response message for Flows.ImportFlow.", + "id": "GoogleCloudDialogflowCxV3beta1ImportFlowResponse", + "properties": { + "flow": { + "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -8264,7 +8962,7 @@ "id": "GoogleCloudDialogflowCxV3beta1Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -8279,7 +8977,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -8980,6 +9678,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { @@ -10144,15 +10846,19 @@ "id": "GoogleCloudDialogflowV2Environment", "properties": { "agentVersion": { - "description": "Optional. The agent version loaded into this environment. Format: `projects//agent/versions/`.", + "description": "Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "type": "string" }, "description": { "description": "Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.", "type": "string" }, + "fulfillment": { + "$ref": "GoogleCloudDialogflowV2Fulfillment", + "description": "Optional. The fulfillment settings to use for this environment." + }, "name": { - "description": "Output only. The unique identifier of this agent environment. Format: `projects//agent/environments/`. For Environment ID, \"-\" is reserved for 'draft' environment.", + "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "readOnly": true, "type": "string" }, @@ -10173,6 +10879,10 @@ "readOnly": true, "type": "string" }, + "textToSpeechSettings": { + "$ref": "GoogleCloudDialogflowV2TextToSpeechSettings", + "description": "Optional. Text to speech settings for this environment." + }, "updateTime": { "description": "Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.", "format": "google-datetime", @@ -10182,6 +10892,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EnvironmentHistory": { + "description": "The response message for Environments.GetEnvironmentHistory.", + "id": "GoogleCloudDialogflowV2EnvironmentHistory", + "properties": { + "entries": { + "description": "Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowV2EnvironmentHistoryEntry" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Output only. Token to retrieve the next page of results, or empty if there are no more results in the list.", + "readOnly": true, + "type": "string" + }, + "parent": { + "description": "Output only. The name of the environment this history is for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2EnvironmentHistoryEntry": { + "description": "Represents an environment history entry.", + "id": "GoogleCloudDialogflowV2EnvironmentHistoryEntry", + "properties": { + "agentVersion": { + "description": "The agent version loaded into this environment history entry.", + "type": "string" + }, + "createTime": { + "description": "The creation time of this environment history entry.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "The developer-provided description for this environment history entry.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EventInput": { "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", "id": "GoogleCloudDialogflowV2EventInput", @@ -10272,7 +11027,7 @@ "id": "GoogleCloudDialogflowV2Fulfillment", "properties": { "displayName": { - "description": "Optional. The human-readable name of the fulfillment, unique within the agent.", + "description": "Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.", "type": "string" }, "enabled": { @@ -10291,7 +11046,7 @@ "description": "Configuration for a generic web service." }, "name": { - "description": "Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`.", + "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.", "type": "string" } }, @@ -10321,7 +11076,7 @@ "id": "GoogleCloudDialogflowV2FulfillmentGenericWebService", "properties": { "isCloudFunction": { - "description": "Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false.", + "description": "Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.", "type": "boolean" }, "password": { @@ -10374,7 +11129,7 @@ "id": "GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig", "properties": { "model": { - "description": "Required. Conversation model resource name. Format: `projects//conversationModels/`.", + "description": "Conversation model resource name. Format: `projects//conversationModels/`.", "type": "string" } }, @@ -11900,6 +12655,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2ListVersionsResponse": { + "description": "The response message for Versions.ListVersions.", + "id": "GoogleCloudDialogflowV2ListVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "versions": { + "description": "The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowV2Version" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2LoggingConfig": { "description": "Defines logging behavior for conversation lifecycle events.", "id": "GoogleCloudDialogflowV2LoggingConfig", @@ -12594,6 +13367,49 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2TextToSpeechSettings": { + "description": "Instructs the speech synthesizer on how to generate the output audio content.", + "id": "GoogleCloudDialogflowV2TextToSpeechSettings", + "properties": { + "enableTextToSpeech": { + "description": "Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.", + "type": "boolean" + }, + "outputAudioEncoding": { + "description": "Required. Audio encoding of the synthesized audio content.", + "enum": [ + "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", + "OUTPUT_AUDIO_ENCODING_LINEAR_16", + "OUTPUT_AUDIO_ENCODING_MP3", + "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", + "OUTPUT_AUDIO_ENCODING_OGG_OPUS", + "OUTPUT_AUDIO_ENCODING_MULAW" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", + "MP3 audio at 32kbps.", + "MP3 audio at 64kbps.", + "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + ], + "type": "string" + }, + "sampleRateHertz": { + "description": "Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).", + "format": "int32", + "type": "integer" + }, + "synthesizeSpeechConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2SynthesizeSpeechConfig" + }, + "description": "Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2TrainAgentRequest": { "description": "The request message for Agents.TrainAgent.", "id": "GoogleCloudDialogflowV2TrainAgentRequest", @@ -12650,6 +13466,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2Version": { + "description": "You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).", + "id": "GoogleCloudDialogflowV2Version", + "properties": { + "createTime": { + "description": "Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The developer-provided description of this version.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The status of this version. This field is read-only and cannot be set by create and update methods.", + "enum": [ + "VERSION_STATUS_UNSPECIFIED", + "IN_PROGRESS", + "READY", + "FAILED" + ], + "enumDescriptions": [ + "Not specified. This value is not used.", + "Version is not ready to serve (e.g. training is in progress).", + "Version is ready to serve.", + "Version training failed." + ], + "readOnly": true, + "type": "string" + }, + "versionNumber": { + "description": "Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2VoiceSelectionParams": { "description": "Description of which voice to use for speech synthesis.", "id": "GoogleCloudDialogflowV2VoiceSelectionParams", @@ -14987,7 +15848,7 @@ "type": "object" }, "GoogleTypeLatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "GoogleTypeLatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 62f0f1ea7ff..a2a18801b84 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -778,6 +778,129 @@ }, "environments": { "methods": { + "create": { + "description": "Creates an agent environment.", + "flatPath": "v2beta1/projects/{projectsId}/agent/environments", + "httpMethod": "POST", + "id": "dialogflow.projects.agent.environments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "environmentId": { + "description": "Required. The unique id of the new environment.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/environments", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified agent environment.", + "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.agent.environments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent environment.", + "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.environments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "getHistory": { + "description": "Gets the history of the specified environment.", + "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/history", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.environments.getHistory", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/history", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1EnvironmentHistory" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all non-draft environments of the specified agent.", "flatPath": "v2beta1/projects/{projectsId}/agent/environments", @@ -814,6 +937,46 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] + }, + "patch": { + "description": "Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use \"-\" as Environment ID in environment name to update version in \"draft\" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.", + "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.agent.environments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowLoadToDraftAndDiscardChanges": { + "description": "Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] } }, "resources": { @@ -2283,6 +2446,163 @@ } } } + }, + "versions": { + "methods": { + "create": { + "description": "Creates an agent version. The new version points to the agent instance in the \"default\" environment.", + "flatPath": "v2beta1/projects/{projectsId}/agent/versions", + "httpMethod": "POST", + "id": "dialogflow.projects.agent.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/versions", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Delete the specified agent version.", + "flatPath": "v2beta1/projects/{projectsId}/agent/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.agent.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent version.", + "flatPath": "v2beta1/projects/{projectsId}/agent/versions/{versionsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all versions of the specified agent.", + "flatPath": "v2beta1/projects/{projectsId}/agent/versions", + "httpMethod": "GET", + "id": "dialogflow.projects.agent.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/versions", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1ListVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.", + "flatPath": "v2beta1/projects/{projectsId}/agent/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.agent.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } } } }, @@ -4145,6 +4465,129 @@ }, "environments": { "methods": { + "create": { + "description": "Creates an agent environment.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agent.environments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "environmentId": { + "description": "Required. The unique id of the new environment.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/environments", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified agent environment.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agent.environments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent environment.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.environments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "getHistory": { + "description": "Gets the history of the specified environment.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/history", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.environments.getHistory", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/history", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1EnvironmentHistory" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all non-draft environments of the specified agent.", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments", @@ -4181,6 +4624,46 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] + }, + "patch": { + "description": "Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use \"-\" as Environment ID in environment name to update version in \"draft\" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agent.environments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowLoadToDraftAndDiscardChanges": { + "description": "Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] } }, "resources": { @@ -5188,42 +5671,199 @@ "https://www.googleapis.com/auth/dialogflow" ] }, - "patch": { - "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.sessions.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] + "patch": { + "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agent.sessions.entityTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "versions": { + "methods": { + "create": { + "description": "Creates an agent version. The new version points to the agent instance in the \"default\" environment.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agent.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+parent}/versions", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Delete the specified agent version.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agent.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent version.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all versions of the specified agent.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agent.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent$", + "required": true, + "type": "string" } - } + }, + "path": "v2beta1/{+parent}/versions", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1ListVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agent.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] } } } @@ -6548,7 +7188,7 @@ } } }, - "revision": "20210412", + "revision": "20210426", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -6786,6 +7426,22 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportFlowResponse": { + "description": "The response message for Flows.ExportFlow.", + "id": "GoogleCloudDialogflowCxV3ExportFlowResponse", + "properties": { + "flowContent": { + "description": "Uncompressed raw byte content for flow.", + "format": "byte", + "type": "string" + }, + "flowUri": { + "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", @@ -7022,6 +7678,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportFlowResponse": { + "description": "The response message for Flows.ImportFlow.", + "id": "GoogleCloudDialogflowCxV3ImportFlowResponse", + "properties": { + "flow": { + "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -7126,7 +7793,7 @@ "id": "GoogleCloudDialogflowCxV3Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -7141,7 +7808,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -7842,6 +8509,10 @@ "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { @@ -8256,6 +8927,22 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportFlowResponse": { + "description": "The response message for Flows.ExportFlow.", + "id": "GoogleCloudDialogflowCxV3beta1ExportFlowResponse", + "properties": { + "flowContent": { + "description": "Uncompressed raw byte content for flow.", + "format": "byte", + "type": "string" + }, + "flowUri": { + "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -8492,6 +9179,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportFlowResponse": { + "description": "The response message for Flows.ImportFlow.", + "id": "GoogleCloudDialogflowCxV3beta1ImportFlowResponse", + "properties": { + "flow": { + "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -8596,7 +9294,7 @@ "id": "GoogleCloudDialogflowCxV3beta1Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -8611,7 +9309,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -9312,6 +10010,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { @@ -12245,6 +12947,10 @@ "description": "Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.", "type": "string" }, + "fulfillment": { + "$ref": "GoogleCloudDialogflowV2beta1Fulfillment", + "description": "Optional. The fulfillment settings to use for this environment." + }, "name": { "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "readOnly": true, @@ -12267,6 +12973,10 @@ "readOnly": true, "type": "string" }, + "textToSpeechSettings": { + "$ref": "GoogleCloudDialogflowV2beta1TextToSpeechSettings", + "description": "Optional. Text to speech settings for this environment." + }, "updateTime": { "description": "Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.", "format": "google-datetime", @@ -12276,6 +12986,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EnvironmentHistory": { + "description": "The response message for Environments.GetEnvironmentHistory.", + "id": "GoogleCloudDialogflowV2beta1EnvironmentHistory", + "properties": { + "entries": { + "description": "Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1EnvironmentHistoryEntry" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Output only. Token to retrieve the next page of results, or empty if there are no more results in the list.", + "readOnly": true, + "type": "string" + }, + "parent": { + "description": "Output only. The name of the environment this history is for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1EnvironmentHistoryEntry": { + "description": "Represents an environment history entry.", + "id": "GoogleCloudDialogflowV2beta1EnvironmentHistoryEntry", + "properties": { + "agentVersion": { + "description": "The agent version loaded into this environment history entry.", + "type": "string" + }, + "createTime": { + "description": "The creation time of this environment history entry.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "The developer-provided description for this environment history entry.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EventInput": { "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", "id": "GoogleCloudDialogflowV2beta1EventInput", @@ -12415,7 +13170,7 @@ "id": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService", "properties": { "isCloudFunction": { - "description": "Indicates if generic web service is created through Cloud Functions integration. Defaults to false.", + "description": "Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.", "type": "boolean" }, "password": { @@ -12493,7 +13248,7 @@ "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationModelConfig", "properties": { "model": { - "description": "Required. Conversation model resource name. Format: `projects//conversationModels/`.", + "description": "Conversation model resource name. Format: `projects//conversationModels/`.", "type": "string" } }, @@ -14461,6 +15216,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ListVersionsResponse": { + "description": "The response message for Versions.ListVersions.", + "id": "GoogleCloudDialogflowV2beta1ListVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "versions": { + "description": "The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1Version" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1LoggingConfig": { "description": "Defines logging behavior for conversation lifecycle events.", "id": "GoogleCloudDialogflowV2beta1LoggingConfig", @@ -15491,6 +16264,49 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1TextToSpeechSettings": { + "description": "Instructs the speech synthesizer on how to generate the output audio content.", + "id": "GoogleCloudDialogflowV2beta1TextToSpeechSettings", + "properties": { + "enableTextToSpeech": { + "description": "Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.", + "type": "boolean" + }, + "outputAudioEncoding": { + "description": "Required. Audio encoding of the synthesized audio content.", + "enum": [ + "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", + "OUTPUT_AUDIO_ENCODING_LINEAR_16", + "OUTPUT_AUDIO_ENCODING_MP3", + "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", + "OUTPUT_AUDIO_ENCODING_OGG_OPUS", + "OUTPUT_AUDIO_ENCODING_MULAW" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", + "MP3 audio at 32kbps.", + "MP3 audio at 64kbps.", + "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + ], + "type": "string" + }, + "sampleRateHertz": { + "description": "Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).", + "format": "int32", + "type": "integer" + }, + "synthesizeSpeechConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig" + }, + "description": "Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1TrainAgentRequest": { "description": "The request message for Agents.TrainAgent.", "id": "GoogleCloudDialogflowV2beta1TrainAgentRequest", @@ -15547,6 +16363,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1Version": { + "description": "You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).", + "id": "GoogleCloudDialogflowV2beta1Version", + "properties": { + "createTime": { + "description": "Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The developer-provided description of this version.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The status of this version. This field is read-only and cannot be set by create and update methods.", + "enum": [ + "VERSION_STATUS_UNSPECIFIED", + "IN_PROGRESS", + "READY", + "FAILED" + ], + "enumDescriptions": [ + "Not specified. This value is not used.", + "Version is not ready to serve (e.g. training is in progress).", + "Version is ready to serve.", + "Version training failed." + ], + "readOnly": true, + "type": "string" + }, + "versionNumber": { + "description": "Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1VoiceSelectionParams": { "description": "Description of which voice to use for speech synthesis.", "id": "GoogleCloudDialogflowV2beta1VoiceSelectionParams", @@ -15840,7 +16701,7 @@ "type": "object" }, "GoogleTypeLatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "GoogleTypeLatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index d6f9fa95bba..4042d982fe2 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -1242,7 +1242,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1297,6 +1297,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "export": { + "description": "Exports the specified flow to a binary file. Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:export", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the flow to export. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:export", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ExportFlowRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "get": { "description": "Retrieves the specified flow.", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}", @@ -1307,7 +1336,7 @@ ], "parameters": { "languageCode": { - "description": "The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1359,6 +1388,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "import": { + "description": "Imports the specified flow to the specified agent from a binary file.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows:import", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to import the flow into. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/flows:import", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ImportFlowRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all flows in the specified agent.", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows", @@ -1369,7 +1427,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1411,7 +1469,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1513,7 +1571,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1578,7 +1636,7 @@ ], "parameters": { "languageCode": { - "description": "The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1609,7 +1667,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1651,7 +1709,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1695,7 +1753,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1760,7 +1818,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1791,7 +1849,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1833,7 +1891,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1986,7 +2044,7 @@ ] }, "load": { - "description": "Loads a specified version to draft version.", + "description": "Loads resources in the specified version to the draft flow.", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:load", "httpMethod": "POST", "id": "dialogflow.projects.locations.agents.flows.versions.load", @@ -1995,7 +2053,7 @@ ], "parameters": { "name": { - "description": "Required. The Version to be loaded to draft version. Format: `projects//locations//agents//flows//versions/`.", + "description": "Required. The Version to be loaded to draft flow. Format: `projects//locations//agents//flows//versions/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", "required": true, @@ -3425,7 +3483,7 @@ } } }, - "revision": "20210412", + "revision": "20210426", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Agent": { @@ -3472,6 +3530,13 @@ "description": "Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.", "type": "string" }, + "supportedLanguageCodes": { + "description": "The list of all languages supported by the agent (except for the `default_language_code`).", + "items": { + "type": "string" + }, + "type": "array" + }, "timeZone": { "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" @@ -4174,6 +4239,10 @@ "agentUri": { "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.", "type": "string" + }, + "environment": { + "description": "Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.", + "type": "string" } }, "type": "object" @@ -4194,6 +4263,37 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportFlowRequest": { + "description": "The request message for Flows.ExportFlow.", + "id": "GoogleCloudDialogflowCxV3ExportFlowRequest", + "properties": { + "flowUri": { + "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the flow to. The format of this URI must be `gs:///`. If left unspecified, the serialized flow is returned inline.", + "type": "string" + }, + "includeReferencedFlows": { + "description": "Optional. Whether to export flows referenced by the specified flow.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportFlowResponse": { + "description": "The response message for Flows.ExportFlow.", + "id": "GoogleCloudDialogflowCxV3ExportFlowResponse", + "properties": { + "flowContent": { + "description": "Uncompressed raw byte content for flow.", + "format": "byte", + "type": "string" + }, + "flowUri": { + "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", @@ -4569,6 +4669,47 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportFlowRequest": { + "description": "The request message for Flows.ImportFlow.", + "id": "GoogleCloudDialogflowCxV3ImportFlowRequest", + "properties": { + "flowContent": { + "description": "Uncompressed raw byte content for flow.", + "format": "byte", + "type": "string" + }, + "flowUri": { + "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import flow from. The format of this URI must be `gs:///`.", + "type": "string" + }, + "importOption": { + "description": "Flow import mode. If not specified, `KEEP` is assumed.", + "enum": [ + "IMPORT_OPTION_UNSPECIFIED", + "KEEP", + "FALLBACK" + ], + "enumDescriptions": [ + "Unspecified. Treated as `KEEP`.", + "Always respect settings in exported flow content. It may cause a import failure if some settings (e.g. custom NLU) are not supported in the agent to import into.", + "Fallback to default settings if some settings are not supported in the agent to import into. E.g. Standard NLU will be used if custom NLU is not available." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportFlowResponse": { + "description": "The response message for Flows.ImportFlow.", + "id": "GoogleCloudDialogflowCxV3ImportFlowResponse", + "properties": { + "flow": { + "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -4689,7 +4830,7 @@ "id": "GoogleCloudDialogflowCxV3Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -4704,7 +4845,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -5096,7 +5237,7 @@ "id": "GoogleCloudDialogflowCxV3LoadVersionRequest", "properties": { "allowOverrideAgentResources": { - "description": "This field is used to prevent accidental overwrite of other agent resources in the draft version, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).", + "description": "This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).", "type": "boolean" } }, @@ -5475,7 +5616,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.", + "description": "This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } ", "type": "object" }, "sessionEntityTypes": { @@ -6697,6 +6838,10 @@ "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { @@ -7111,6 +7256,22 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportFlowResponse": { + "description": "The response message for Flows.ExportFlow.", + "id": "GoogleCloudDialogflowCxV3beta1ExportFlowResponse", + "properties": { + "flowContent": { + "description": "Uncompressed raw byte content for flow.", + "format": "byte", + "type": "string" + }, + "flowUri": { + "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -7347,6 +7508,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportFlowResponse": { + "description": "The response message for Flows.ImportFlow.", + "id": "GoogleCloudDialogflowCxV3beta1ImportFlowResponse", + "properties": { + "flow": { + "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -7451,7 +7623,7 @@ "id": "GoogleCloudDialogflowCxV3beta1Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -7466,7 +7638,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -8167,6 +8339,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { @@ -12209,7 +12385,7 @@ "type": "object" }, "GoogleTypeLatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "GoogleTypeLatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index bf5a372b613..bf6347b9e08 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -1242,7 +1242,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1307,7 +1307,7 @@ ], "parameters": { "languageCode": { - "description": "The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1369,7 +1369,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1411,7 +1411,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1513,7 +1513,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1578,7 +1578,7 @@ ], "parameters": { "languageCode": { - "description": "The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1609,7 +1609,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1651,7 +1651,7 @@ ], "parameters": { "languageCode": { - "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1695,7 +1695,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1760,7 +1760,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1791,7 +1791,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1833,7 +1833,7 @@ ], "parameters": { "languageCode": { - "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" }, @@ -1986,7 +1986,7 @@ ] }, "load": { - "description": "Loads a specified version to draft version.", + "description": "Loads resources in the specified version to the draft flow.", "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:load", "httpMethod": "POST", "id": "dialogflow.projects.locations.agents.flows.versions.load", @@ -1995,7 +1995,7 @@ ], "parameters": { "name": { - "description": "Required. The Version to be loaded to draft version. Format: `projects//locations//agents//flows//versions/`.", + "description": "Required. The Version to be loaded to draft flow. Format: `projects//locations//agents//flows//versions/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", "required": true, @@ -3425,7 +3425,7 @@ } } }, - "revision": "20210412", + "revision": "20210417", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -4003,7 +4003,7 @@ "id": "GoogleCloudDialogflowCxV3Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -4018,7 +4018,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -4719,6 +4719,10 @@ "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { @@ -6159,7 +6163,7 @@ "id": "GoogleCloudDialogflowCxV3beta1Intent", "properties": { "description": { - "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" }, "displayName": { @@ -6174,7 +6178,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", + "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", "type": "object" }, "name": { @@ -6566,7 +6570,7 @@ "id": "GoogleCloudDialogflowCxV3beta1LoadVersionRequest", "properties": { "allowOverrideAgentResources": { - "description": "This field is used to prevent accidental overwrite of other agent resources in the draft version, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).", + "description": "This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).", "type": "boolean" } }, @@ -8167,6 +8171,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", "description": "Information about the last matched intent." }, + "languageCode": { + "description": "The language code specified in the original request.", + "type": "string" + }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "items": { diff --git a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json index 368a1817f9c..fbe694d0465 100644 --- a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +++ b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json @@ -184,7 +184,7 @@ } } }, - "revision": "20210405", + "revision": "20210419", "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 a1c181d56f3..bfad482587b 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v1.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v1.json @@ -2345,7 +2345,7 @@ "type": "string" }, "filter": { - "description": "Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * The operator can be `NO LESS THAN (>=)` or `NO GREATER THAN (<=)`. - `updateTime` (format of ISO 8601) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items whose flight dates end before March 28, 2019: `flight.dateRange.endDate<\"2019-03-28\"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:\"NO_VALID_CREATIVE\"` * All line items with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters.", + "description": "Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported properties: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - `targetedChannelId` - `targetedNegativeKeywordListId` Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items whose flight dates end before March 28, 2019: `flight.dateRange.endDate<\"2019-03-28\"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:\"NO_VALID_CREATIVE\"` * All line items with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>=\"2020-11-04T18:54:47Z\"` * All line items that are using both the specified channel and specified negative keyword list in their targeting: `targetedNegativeKeywordListId=789 AND targetedChannelId=12345` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -7071,7 +7071,7 @@ } } }, - "revision": "20210408", + "revision": "20210422", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -7258,7 +7258,7 @@ "type": "string" }, "entityStatus": { - "description": "Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.", + "description": "Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.", "enum": [ "ENTITY_STATUS_UNSPECIFIED", "ENTITY_STATUS_ACTIVE", @@ -8767,10 +8767,22 @@ "readOnly": true, "type": "string" }, + "negativelyTargetedLineItemCount": { + "description": "Output only. Number of line items that are directly targeting this channel negatively.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "partnerId": { "description": "The ID of the partner that owns the channel.", "format": "int64", "type": "string" + }, + "positivelyTargetedLineItemCount": { + "description": "Output only. Number of line items that are directly targeting this channel positively.", + "format": "int64", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -13737,6 +13749,12 @@ "format": "int64", "readOnly": true, "type": "string" + }, + "targetedLineItemCount": { + "description": "Output only. Number of line items that are directly targeting this negative keyword list.", + "format": "int64", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 91160598403..3cc9631ce82 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -3367,7 +3367,7 @@ } } }, - "revision": "20210403", + "revision": "20210423", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -7041,7 +7041,7 @@ "type": "object" }, "GooglePrivacyDlpV2Table": { - "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more.", + "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more.", "id": "GooglePrivacyDlpV2Table", "properties": { "headers": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index a91d31615fb..af7ab2f5fbe 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1245,7 +1245,7 @@ } } }, - "revision": "20210409", + "revision": "20210423", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -1677,6 +1677,7 @@ }, "kind": { "default": "dns#managedZoneOperationsListResponse", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index ecf5f197247..e6fc6c98e5f 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1740,7 +1740,7 @@ } } }, - "revision": "20210409", + "revision": "20210423", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2176,6 +2176,7 @@ }, "kind": { "default": "dns#managedZoneOperationsListResponse", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -2227,6 +2228,13 @@ "ManagedZonePrivateVisibilityConfig": { "id": "ManagedZonePrivateVisibilityConfig", "properties": { + "gkeClusters": { + "description": "The list of Google Kubernetes Engine clusters that can see this zone.", + "items": { + "$ref": "ManagedZonePrivateVisibilityConfigGKECluster" + }, + "type": "array" + }, "kind": { "default": "dns#managedZonePrivateVisibilityConfig", "type": "string" @@ -2241,6 +2249,20 @@ }, "type": "object" }, + "ManagedZonePrivateVisibilityConfigGKECluster": { + "id": "ManagedZonePrivateVisibilityConfigGKECluster", + "properties": { + "gkeClusterName": { + "description": "The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get", + "type": "string" + }, + "kind": { + "default": "dns#managedZonePrivateVisibilityConfigGKECluster", + "type": "string" + } + }, + "type": "object" + }, "ManagedZonePrivateVisibilityConfigNetwork": { "id": "ManagedZonePrivateVisibilityConfigNetwork", "properties": { @@ -2584,6 +2606,11 @@ "format": "int32", "type": "integer" }, + "gkeClustersPerManagedZone": { + "description": "Maximum allowed number of GKE clusters to which a privately scoped zone can be attached.", + "format": "int32", + "type": "integer" + }, "kind": { "default": "dns#quota", "type": "string" @@ -2593,6 +2620,11 @@ "format": "int32", "type": "integer" }, + "managedZonesPerGkeCluster": { + "description": "Maximum allowed number of managed zones which can be attached to a GKE cluster.", + "format": "int32", + "type": "integer" + }, "managedZonesPerNetwork": { "description": "Maximum allowed number of managed zones which can be attached to a network.", "format": "int32", @@ -2789,6 +2821,13 @@ "description": "User-provided description for this Response Policy.", "type": "string" }, + "gkeClusters": { + "description": "The list of Google Kubernetes Engine clusters to which this response policy is applied.", + "items": { + "$ref": "ResponsePolicyGKECluster" + }, + "type": "array" + }, "id": { "description": "Unique identifier for the resource; defined by the server (output only).", "format": "int64", @@ -2812,6 +2851,20 @@ }, "type": "object" }, + "ResponsePolicyGKECluster": { + "id": "ResponsePolicyGKECluster", + "properties": { + "gkeClusterName": { + "description": "The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get", + "type": "string" + }, + "kind": { + "default": "dns#responsePolicyGKECluster", + "type": "string" + } + }, + "type": "object" + }, "ResponsePolicyNetwork": { "id": "ResponsePolicyNetwork", "properties": { diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 0ac2db6107f..245f62ebcb4 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20210329", + "revision": "20210422", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index 81a08f61258..954beae0e5b 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -254,7 +254,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -544,7 +544,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -601,7 +601,7 @@ } } }, - "revision": "20210407", + "revision": "20210426", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata": { @@ -802,6 +802,11 @@ "description": "The dataset validation information. This includes any and all errors with documents and the dataset.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", "properties": { + "datasetErrorCount": { + "description": "The total number of dataset errors.", + "format": "int32", + "type": "integer" + }, "datasetErrors": { "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", "items": { @@ -809,6 +814,11 @@ }, "type": "array" }, + "documentErrorCount": { + "description": "The total number of document errors.", + "format": "int32", + "type": "integer" + }, "documentErrors": { "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", "items": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json index 00a777e70ab..9430d4bd17f 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json @@ -292,7 +292,7 @@ } } }, - "revision": "20210407", + "revision": "20210426", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata": { @@ -493,6 +493,11 @@ "description": "The dataset validation information. This includes any and all errors with documents and the dataset.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", "properties": { + "datasetErrorCount": { + "description": "The total number of dataset errors.", + "format": "int32", + "type": "integer" + }, "datasetErrors": { "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", "items": { @@ -500,6 +505,11 @@ }, "type": "array" }, + "documentErrorCount": { + "description": "The total number of document errors.", + "format": "int32", + "type": "integer" + }, "documentErrors": { "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", "items": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index b17a377b2ef..43d6a6f95db 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -109,6 +109,31 @@ "resources": { "locations": { "methods": { + "fetchProcessorTypes": { + "description": "Fetches processor types.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes", + "httpMethod": "GET", + "id": "documentai.projects.locations.fetchProcessorTypes", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project of processor type to list. The available processor types may depend on the whitelisting on projects. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}:fetchProcessorTypes", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets information about a location.", "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}", @@ -156,7 +181,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -236,6 +261,151 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "create": { + "description": "Creates a processor from the type processor that the user chose. The processor will be at \"ENABLED\" state by default after its creation.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/processors", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3Processor" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3Processor" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}", + "httpMethod": "DELETE", + "id": "documentai.projects.locations.processors.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The processor resource name to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disables a processor", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The processor resource name to be disabled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}:disable", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3DisableProcessorRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enable": { + "description": "Enables a processor", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The processor resource name to be enabled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}:enable", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3EnableProcessorRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all processors which belong to this project.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors", + "httpMethod": "GET", + "id": "documentai.projects.locations.processors.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "We will return the processors sorted by creation time. The page token will point to the next processor.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/processors", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3ListProcessorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "process": { "description": "Processes a single document.", "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process", @@ -365,7 +535,7 @@ } } }, - "revision": "20210407", + "revision": "20210426", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata": { @@ -566,6 +736,11 @@ "description": "The dataset validation information. This includes any and all errors with documents and the dataset.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", "properties": { + "datasetErrorCount": { + "description": "The total number of dataset errors.", + "format": "int32", + "type": "integer" + }, "datasetErrors": { "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", "items": { @@ -573,6 +748,11 @@ }, "type": "array" }, + "documentErrorCount": { + "description": "The total number of document errors.", + "format": "int32", + "type": "integer" + }, "documentErrors": { "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", "items": { @@ -3292,6 +3472,12 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DisableProcessorRequest": { + "description": "Request message for the disable processor method.", + "id": "GoogleCloudDocumentaiV1beta3DisableProcessorRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3Document": { "description": "Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.", "id": "GoogleCloudDocumentaiV1beta3Document", @@ -4254,6 +4440,26 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3EnableProcessorRequest": { + "description": "Request message for the enable processor method.", + "id": "GoogleCloudDocumentaiV1beta3EnableProcessorRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse": { + "description": "Response message for fetch processor types.", + "id": "GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse", + "properties": { + "processorTypes": { + "description": "The list of processor types.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorType" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3GcsDocument": { "description": "Specifies a document stored on Cloud Storage.", "id": "GoogleCloudDocumentaiV1beta3GcsDocument", @@ -4327,6 +4533,24 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ListProcessorsResponse": { + "description": "Response message for list processors.", + "id": "GoogleCloudDocumentaiV1beta3ListProcessorsResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next processor, otherwise empty.", + "type": "string" + }, + "processors": { + "description": "The list of processors.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3Processor" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3NormalizedVertex": { "description": "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.", "id": "GoogleCloudDocumentaiV1beta3NormalizedVertex", @@ -4386,6 +4610,114 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3Processor": { + "description": "The first-class citizen for DAI. Each processor defines how to extract structural information from a document.", + "id": "GoogleCloudDocumentaiV1beta3Processor", + "properties": { + "createTime": { + "description": "The time the processor was created.", + "format": "google-datetime", + "type": "string" + }, + "defaultProcessorVersion": { + "description": "The default processor version.", + "type": "string" + }, + "displayName": { + "description": "The display name of the processor.", + "type": "string" + }, + "kmsKeyName": { + "description": "The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.", + "type": "string" + }, + "name": { + "description": "Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}", + "readOnly": true, + "type": "string" + }, + "processEndpoint": { + "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the processor.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "ENABLING", + "DISABLING", + "CREATING", + "FAILED", + "DELETING" + ], + "enumDescriptions": [ + "The processor is in an unspecified state.", + "The processor is enabled, i.e, has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", + "The processor is disabled.", + "The processor is being enabled, will become ENABLED if successful.", + "The processor is being disabled, will become DISABLED if successful.", + "The processor is being created, will become either ENABLED (for successful creation) or FAILED (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", + "The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", + "The processor is being deleted, will be removed if successful." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessorType": { + "description": "A processor type is responsible for performing a certain document understanding task on a certain type of document. All processor types are created by the documentai service internally. User will only list all available processor types via UI. For different users (projects), the available processor types may be different since we'll expose the access of some types via EAP whitelisting. We make the ProcessorType a resource under location so we have a unified API and keep the possibility that UI will load different available processor types from different regions. But for alpha the behavior is that the user will always get the union of all available processor types among all regions no matter which regionalized endpoint is called, and then we use the 'available_locations' field to show under which regions a processor type is available. For example, users can call either the 'US' or 'EU' endpoint to feach processor types. In the return, we will have an 'invoice parsing' processor with 'available_locations' field only containing 'US'. So the user can try to create an 'invoice parsing' processor under the location 'US'. Such attempt of creating under the location 'EU' will fail. Next ID: 7.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorType", + "properties": { + "allowCreation": { + "description": "Whether the processor type allows creation. If yes, user can create a processor of this processor type. Otherwise, user needs to require for whitelisting.", + "type": "boolean" + }, + "availableLocations": { + "description": "The locations in which this processor is available.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo" + }, + "type": "array" + }, + "category": { + "description": "The processor category, used by UI to group processor types.", + "type": "string" + }, + "name": { + "description": "The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}", + "type": "string" + }, + "schema": { + "$ref": "GoogleCloudDocumentaiV1beta3Schema", + "description": "The schema of the default version of this processor type." + }, + "type": { + "description": "The type of the processor, e.g, \"invoice_parsing\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo": { + "description": "The location information about where the processor is available.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo", + "properties": { + "locationId": { + "description": "The location id, currently must be one of [us, eu].", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3RawDocument": { "description": "Payload message of raw document content (bytes).", "id": "GoogleCloudDocumentaiV1beta3RawDocument", @@ -4473,6 +4805,93 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3Schema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiV1beta3Schema", + "properties": { + "description": { + "description": "Description of the schema.", + "type": "string" + }, + "displayName": { + "description": "Display name to show to users.", + "type": "string" + }, + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaEntityType" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3SchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiV1beta3SchemaEntityType", + "properties": { + "baseType": { + "description": "Type of the entity. It must be one of the following: `document` - the entity represents a classification of a logical document. `object` - if the entity has properties it is likely an object (or or a document.) `datetime` - the entity is a date or time value. `money` - the entity represents a money value amount. `number` - the entity is a number - integer or floating point. `string` - the entity is a string value. `boolean` - the entity is a boolean value. `address` - the entity is a location address.", + "type": "string" + }, + "description": { + "description": "Description of the entity type.", + "type": "string" + }, + "enumValues": { + "description": "For some entity types there are only a few possible values. They can be specified here.", + "items": { + "type": "string" + }, + "type": "array" + }, + "occurrenceType": { + "description": "Occurrence type limits the number of times an entity type appears in the document.", + "enum": [ + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" + ], + "enumDescriptions": [ + "Unspecified occurrence type.", + "The entity type will appear zero times or once.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once.", + "The entity type will appear once or more times." + ], + "type": "string" + }, + "properties": { + "description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType 'ID', which consists of EntityType 'name' and 'address', with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaEntityType" + }, + "type": "array" + }, + "source": { + "description": "Source of this entity type.", + "enum": [ + "SOURCE_UNSPECIFIED", + "PREDEFINED", + "USER_INPUT" + ], + "enumDescriptions": [ + "Unspecified source.", + "The entity type is in the predefined schema of a pretrained version of a processor.", + "The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor." + ], + "type": "string" + }, + "type": { + "description": "Name of the type. It must be unique within the set of same level types.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudDocumentaiV1beta3Vertex", diff --git a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json index 864d0dba2af..cea4738ca26 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -144,7 +144,7 @@ ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -156,13 +156,13 @@ "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } @@ -721,7 +721,7 @@ } } }, - "revision": "20210216", + "revision": "20210419", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/domains.v1beta1.json b/googleapiclient/discovery_cache/documents/domains.v1beta1.json index dc6d398799a..df79a39524f 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/domains.v1beta1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -144,7 +144,7 @@ ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -156,13 +156,13 @@ "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } @@ -721,7 +721,7 @@ } } }, - "revision": "20210216", + "revision": "20210419", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json index 6868d9df1f8..679bf9c94f9 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, - "revision": "20210408", + "revision": "20210427", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json index 47bc9a40f43..3961a50bbbf 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.json @@ -306,7 +306,7 @@ } } }, - "revision": "20210331", + "revision": "20210406", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "DownloadLineItemsRequest": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v11.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v11.json index 0a6cfe17abc..c80ec5cd92e 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v11.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v11.json @@ -342,7 +342,7 @@ } } }, - "revision": "20210331", + "revision": "20210406", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { @@ -814,7 +814,8 @@ "FILTER_OM_SDK_AVAILABLE", "FILTER_DATA_SOURCE", "FILTER_CM360_PLACEMENT_ID", - "FILTER_TRUEVIEW_CLICK_TYPE_NAME" + "FILTER_TRUEVIEW_CLICK_TYPE_NAME", + "FILTER_TRUEVIEW_AD_TYPE_NAME" ], "enumDescriptions": [ "", @@ -1080,6 +1081,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1428,7 +1430,8 @@ "FILTER_OM_SDK_AVAILABLE", "FILTER_DATA_SOURCE", "FILTER_CM360_PLACEMENT_ID", - "FILTER_TRUEVIEW_CLICK_TYPE_NAME" + "FILTER_TRUEVIEW_CLICK_TYPE_NAME", + "FILTER_TRUEVIEW_AD_TYPE_NAME" ], "enumDescriptions": [ "", @@ -1694,6 +1697,7 @@ "", "", "", + "", "" ], "type": "string" @@ -3024,7 +3028,8 @@ "FILTER_OM_SDK_AVAILABLE", "FILTER_DATA_SOURCE", "FILTER_CM360_PLACEMENT_ID", - "FILTER_TRUEVIEW_CLICK_TYPE_NAME" + "FILTER_TRUEVIEW_CLICK_TYPE_NAME", + "FILTER_TRUEVIEW_AD_TYPE_NAME" ], "enumDescriptions": [ "", @@ -3290,6 +3295,7 @@ "", "", "", + "", "" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json index 95364b016b3..e4c6802ac5a 100644 --- a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json @@ -399,7 +399,7 @@ } } }, - "revision": "20210409", + "revision": "20210422", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index da9cedcf200..46a8587fed9 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/caoLcrPNlqW4zj9323ON2YLaWnI\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/eQF4I95O1DZouFXGqPCiKaiuYnM\"", "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" @@ -1341,7 +1341,7 @@ ] }, "get": { - "description": "Gets a file's metadata by ID.", + "description": "Gets a file's metadata or content by ID.", "httpMethod": "GET", "id": "drive.files.get", "parameterOrder": [ @@ -3521,7 +3521,7 @@ } } }, - "revision": "20210322", + "revision": "20210419", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4186,7 +4186,7 @@ "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.", + "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.", "type": "string" }, "author": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 5ac70fe21b4..20ad8e170e9 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/Nyk9QooT1-WBB03Ilrr_sA6IsJk\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/Ksil8aMte9Wb7BMjA_3uaIrQVnc\"", "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" @@ -2185,7 +2185,7 @@ } } }, - "revision": "20210322", + "revision": "20210419", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -2462,7 +2462,7 @@ "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.", + "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.", "type": "string" }, "author": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index 7caf958b5ac..e146950f248 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, - "revision": "20210406", + "revision": "20210423", "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 new file mode 100644 index 00000000000..55636545a07 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -0,0 +1,1010 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud Platform data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://essentialcontacts.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Essentialcontacts", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/essentialcontacts/docs/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "essentialcontacts:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://essentialcontacts.mtls.googleapis.com/", + "name": "essentialcontacts", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "folders": { + "resources": { + "contacts": { + "methods": { + "compute": { + "description": "Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.", + "flatPath": "v1/folders/{foldersId}/contacts:compute", + "httpMethod": "GET", + "id": "essentialcontacts.folders.contacts.compute", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notificationCategories": { + "description": "The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.", + "enum": [ + "NOTIFICATION_CATEGORY_UNSPECIFIED", + "ALL", + "SUSPENSION", + "SECURITY", + "TECHNICAL", + "BILLING", + "LEGAL", + "PRODUCT_UPDATES", + "TECHNICAL_INCIDENTS" + ], + "enumDescriptions": [ + "Notification category is unrecognized or unspecified.", + "All notifications related to the resource, including notifications pertaining to categories added in the future.", + "Notifications related to imminent account suspension.", + "Notifications related to security/privacy incidents, notifications, and vulnerabilities.", + "Notifications related to technical events and issues such as outages, errors, or bugs.", + "Notifications related to billing and payments notifications, price updates, errors, or credits.", + "Notifications related to enforcement actions, regulatory compliance, or government notices.", + "Notifications related to new versions, product terms updates, or deprecations.", + "Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts:compute", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Adds a new contact for a resource.", + "flatPath": "v1/folders/{foldersId}/contacts", + "httpMethod": "POST", + "id": "essentialcontacts.folders.contacts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a contact.", + "flatPath": "v1/folders/{foldersId}/contacts/{contactsId}", + "httpMethod": "DELETE", + "id": "essentialcontacts.folders.contacts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^folders/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a single contact.", + "flatPath": "v1/folders/{foldersId}/contacts/{contactsId}", + "httpMethod": "GET", + "id": "essentialcontacts.folders.contacts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^folders/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the contacts that have been set on a resource.", + "flatPath": "v1/folders/{foldersId}/contacts", + "httpMethod": "GET", + "id": "essentialcontacts.folders.contacts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a contact. Note: A contact's email address cannot be changed.", + "flatPath": "v1/folders/{foldersId}/contacts/{contactsId}", + "httpMethod": "PATCH", + "id": "essentialcontacts.folders.contacts.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^folders/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "sendTestMessage": { + "description": "Allows a contact admin to send a test message to contact to verify that it has been configured correctly.", + "flatPath": "v1/folders/{foldersId}/contacts:sendTestMessage", + "httpMethod": "POST", + "id": "essentialcontacts.folders.contacts.sendTestMessage", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}/contacts:sendTestMessage", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1SendTestMessageRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "organizations": { + "resources": { + "contacts": { + "methods": { + "compute": { + "description": "Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.", + "flatPath": "v1/organizations/{organizationsId}/contacts:compute", + "httpMethod": "GET", + "id": "essentialcontacts.organizations.contacts.compute", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notificationCategories": { + "description": "The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.", + "enum": [ + "NOTIFICATION_CATEGORY_UNSPECIFIED", + "ALL", + "SUSPENSION", + "SECURITY", + "TECHNICAL", + "BILLING", + "LEGAL", + "PRODUCT_UPDATES", + "TECHNICAL_INCIDENTS" + ], + "enumDescriptions": [ + "Notification category is unrecognized or unspecified.", + "All notifications related to the resource, including notifications pertaining to categories added in the future.", + "Notifications related to imminent account suspension.", + "Notifications related to security/privacy incidents, notifications, and vulnerabilities.", + "Notifications related to technical events and issues such as outages, errors, or bugs.", + "Notifications related to billing and payments notifications, price updates, errors, or credits.", + "Notifications related to enforcement actions, regulatory compliance, or government notices.", + "Notifications related to new versions, product terms updates, or deprecations.", + "Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts:compute", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Adds a new contact for a resource.", + "flatPath": "v1/organizations/{organizationsId}/contacts", + "httpMethod": "POST", + "id": "essentialcontacts.organizations.contacts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a contact.", + "flatPath": "v1/organizations/{organizationsId}/contacts/{contactsId}", + "httpMethod": "DELETE", + "id": "essentialcontacts.organizations.contacts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^organizations/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a single contact.", + "flatPath": "v1/organizations/{organizationsId}/contacts/{contactsId}", + "httpMethod": "GET", + "id": "essentialcontacts.organizations.contacts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^organizations/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the contacts that have been set on a resource.", + "flatPath": "v1/organizations/{organizationsId}/contacts", + "httpMethod": "GET", + "id": "essentialcontacts.organizations.contacts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a contact. Note: A contact's email address cannot be changed.", + "flatPath": "v1/organizations/{organizationsId}/contacts/{contactsId}", + "httpMethod": "PATCH", + "id": "essentialcontacts.organizations.contacts.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^organizations/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "sendTestMessage": { + "description": "Allows a contact admin to send a test message to contact to verify that it has been configured correctly.", + "flatPath": "v1/organizations/{organizationsId}/contacts:sendTestMessage", + "httpMethod": "POST", + "id": "essentialcontacts.organizations.contacts.sendTestMessage", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}/contacts:sendTestMessage", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1SendTestMessageRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "projects": { + "resources": { + "contacts": { + "methods": { + "compute": { + "description": "Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.", + "flatPath": "v1/projects/{projectsId}/contacts:compute", + "httpMethod": "GET", + "id": "essentialcontacts.projects.contacts.compute", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notificationCategories": { + "description": "The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.", + "enum": [ + "NOTIFICATION_CATEGORY_UNSPECIFIED", + "ALL", + "SUSPENSION", + "SECURITY", + "TECHNICAL", + "BILLING", + "LEGAL", + "PRODUCT_UPDATES", + "TECHNICAL_INCIDENTS" + ], + "enumDescriptions": [ + "Notification category is unrecognized or unspecified.", + "All notifications related to the resource, including notifications pertaining to categories added in the future.", + "Notifications related to imminent account suspension.", + "Notifications related to security/privacy incidents, notifications, and vulnerabilities.", + "Notifications related to technical events and issues such as outages, errors, or bugs.", + "Notifications related to billing and payments notifications, price updates, errors, or credits.", + "Notifications related to enforcement actions, regulatory compliance, or government notices.", + "Notifications related to new versions, product terms updates, or deprecations.", + "Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL." + ], + "location": "query", + "repeated": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts:compute", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Adds a new contact for a resource.", + "flatPath": "v1/projects/{projectsId}/contacts", + "httpMethod": "POST", + "id": "essentialcontacts.projects.contacts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a contact.", + "flatPath": "v1/projects/{projectsId}/contacts/{contactsId}", + "httpMethod": "DELETE", + "id": "essentialcontacts.projects.contacts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^projects/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a single contact.", + "flatPath": "v1/projects/{projectsId}/contacts/{contactsId}", + "httpMethod": "GET", + "id": "essentialcontacts.projects.contacts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^projects/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the contacts that have been set on a resource.", + "flatPath": "v1/projects/{projectsId}/contacts", + "httpMethod": "GET", + "id": "essentialcontacts.projects.contacts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contacts", + "response": { + "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a contact. Note: A contact's email address cannot be changed.", + "flatPath": "v1/projects/{projectsId}/contacts/{contactsId}", + "httpMethod": "PATCH", + "id": "essentialcontacts.projects.contacts.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}", + "location": "path", + "pattern": "^projects/[^/]+/contacts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "response": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "sendTestMessage": { + "description": "Allows a contact admin to send a test message to contact to verify that it has been configured correctly.", + "flatPath": "v1/projects/{projectsId}/contacts:sendTestMessage", + "httpMethod": "POST", + "id": "essentialcontacts.projects.contacts.sendTestMessage", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}/contacts:sendTestMessage", + "request": { + "$ref": "GoogleCloudEssentialcontactsV1SendTestMessageRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20210426", + "rootUrl": "https://essentialcontacts.googleapis.com/", + "schemas": { + "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { + "description": "Response message for the ComputeContacts method.", + "id": "GoogleCloudEssentialcontactsV1ComputeContactsResponse", + "properties": { + "contacts": { + "description": "All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.", + "items": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudEssentialcontactsV1Contact": { + "description": "A contact that will receive notifications from Google Cloud.", + "id": "GoogleCloudEssentialcontactsV1Contact", + "properties": { + "email": { + "description": "Required. The email address to send notifications to. This does not need to be a Google account.", + "type": "string" + }, + "languageTag": { + "description": "The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.", + "type": "string" + }, + "name": { + "description": "The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}", + "type": "string" + }, + "notificationCategorySubscriptions": { + "description": "The categories of notifications that the contact will receive communications for.", + "items": { + "enum": [ + "NOTIFICATION_CATEGORY_UNSPECIFIED", + "ALL", + "SUSPENSION", + "SECURITY", + "TECHNICAL", + "BILLING", + "LEGAL", + "PRODUCT_UPDATES", + "TECHNICAL_INCIDENTS" + ], + "enumDescriptions": [ + "Notification category is unrecognized or unspecified.", + "All notifications related to the resource, including notifications pertaining to categories added in the future.", + "Notifications related to imminent account suspension.", + "Notifications related to security/privacy incidents, notifications, and vulnerabilities.", + "Notifications related to technical events and issues such as outages, errors, or bugs.", + "Notifications related to billing and payments notifications, price updates, errors, or credits.", + "Notifications related to enforcement actions, regulatory compliance, or government notices.", + "Notifications related to new versions, product terms updates, or deprecations.", + "Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL." + ], + "type": "string" + }, + "type": "array" + }, + "validateTime": { + "description": "The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.", + "format": "google-datetime", + "type": "string" + }, + "validationState": { + "description": "The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", + "enum": [ + "VALIDATION_STATE_UNSPECIFIED", + "VALID", + "INVALID" + ], + "enumDescriptions": [ + "The validation state is unknown or unspecified.", + "The contact is marked as valid. This is usually done manually by the contact admin. All new contacts begin in the valid state.", + "The contact is considered invalid. This may become the state if the contact's email is found to be unreachable." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudEssentialcontactsV1ListContactsResponse": { + "description": "Response message for the ListContacts method.", + "id": "GoogleCloudEssentialcontactsV1ListContactsResponse", + "properties": { + "contacts": { + "description": "The contacts for the specified resource.", + "items": { + "$ref": "GoogleCloudEssentialcontactsV1Contact" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudEssentialcontactsV1SendTestMessageRequest": { + "description": "Request message for the SendTestMessage method.", + "id": "GoogleCloudEssentialcontactsV1SendTestMessageRequest", + "properties": { + "contacts": { + "description": "Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}", + "items": { + "type": "string" + }, + "type": "array" + }, + "notificationCategory": { + "description": "Required. The notification category to send the test message for. All contacts must be subscribed to this category.", + "enum": [ + "NOTIFICATION_CATEGORY_UNSPECIFIED", + "ALL", + "SUSPENSION", + "SECURITY", + "TECHNICAL", + "BILLING", + "LEGAL", + "PRODUCT_UPDATES", + "TECHNICAL_INCIDENTS" + ], + "enumDescriptions": [ + "Notification category is unrecognized or unspecified.", + "All notifications related to the resource, including notifications pertaining to categories added in the future.", + "Notifications related to imminent account suspension.", + "Notifications related to security/privacy incidents, notifications, and vulnerabilities.", + "Notifications related to technical events and issues such as outages, errors, or bugs.", + "Notifications related to billing and payments notifications, price updates, errors, or credits.", + "Notifications related to enforcement actions, regulatory compliance, or government notices.", + "Notifications related to new versions, product terms updates, or deprecations.", + "Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "Essential Contacts API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json index a0e08d08174..a052129a089 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -584,7 +584,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "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 7af038c50a5..ab2ad505191 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -584,7 +584,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "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 8ba076d2c03..d6c645f89fc 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -304,7 +304,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "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 1255b968e9f..cddffa40244 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -142,7 +142,7 @@ } } }, - "revision": "20210405", + "revision": "20210426", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index 5ac0e060f0e..fc5fbd22c90 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -161,7 +161,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -672,7 +672,7 @@ } } }, - "revision": "20210331", + "revision": "20210409", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -905,7 +905,7 @@ "description": "Optional. The MaintenanceSettings associated with instance." }, "name": { - "description": "Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}`", + "description": "Unique name of the resource. It uses the form: `projects/{project_id|project_number}/locations/{location_id}/instances/{instance_id}` Note: Either project_id or project_number and be used, but keep it consistent with other APIs (e.g. RescheduleUpdate)", "type": "string" }, "producerMetadata": { @@ -1197,6 +1197,11 @@ }, "type": "array" }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. The instance state.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index 717f72857be..d2b1984cca4 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -161,7 +161,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -672,7 +672,7 @@ } } }, - "revision": "20210331", + "revision": "20210409", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -905,7 +905,7 @@ "description": "Optional. The MaintenanceSettings associated with instance." }, "name": { - "description": "Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}`", + "description": "Unique name of the resource. It uses the form: `projects/{project_id|project_number}/locations/{location_id}/instances/{instance_id}` Note: Either project_id or project_number and be used, but keep it consistent with other APIs (e.g. RescheduleUpdate)", "type": "string" }, "producerMetadata": { @@ -1197,6 +1197,11 @@ }, "type": "array" }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. The instance state.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json index 8fe405639de..2953e0b1730 100644 --- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json @@ -1121,7 +1121,7 @@ } } }, - "revision": "20210409", + "revision": "20210424", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index 387bfb115db..c3777e6bdf6 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -317,7 +317,7 @@ } } }, - "revision": "20210409", + "revision": "20210424", "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 58643458c85..f5b7e57a9db 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, - "revision": "20210405", + "revision": "20210426", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json index af35a0cd504..2885e9db242 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -186,7 +186,7 @@ } } }, - "revision": "20210315", + "revision": "20210422", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json index b172d52a619..c67aa204cfc 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud Platform services" @@ -1939,7 +1939,7 @@ } } }, - "revision": "20210315", + "revision": "20210422", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index 989bdd6cdbe..f6a786ef749 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -204,7 +204,7 @@ } } }, - "revision": "20210407", + "revision": "20210426", "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 a5b12ae1ffe..dcf16298cfe 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json @@ -318,7 +318,7 @@ } } }, - "revision": "20210407", + "revision": "20210426", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "DownloadModelResponse": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index e6d239be900..1d16eb69572 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1135,7 +1135,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1160,7 +1160,7 @@ } } }, - "revision": "20210326", + "revision": "20210419", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "ArrayValue": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index 1fe91df6df0..bddff80941a 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -849,7 +849,7 @@ } } }, - "revision": "20210326", + "revision": "20210419", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "ArrayValue": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json index 8b3c228efb1..a04d3e2289e 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json @@ -415,7 +415,7 @@ } } }, - "revision": "20210326", + "revision": "20210419", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json index 6fdca504459..f6e735c5131 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -831,7 +831,7 @@ } } }, - "revision": "20210410", + "revision": "20210422", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/googleapiclient/discovery_cache/documents/games.v1.json b/googleapiclient/discovery_cache/documents/games.v1.json index b714eb9eeb9..65b63249e57 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -1224,7 +1224,7 @@ } } }, - "revision": "20210408", + "revision": "20210422", "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 b9ff299eea1..f7f42e3ae75 100644 --- a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +++ b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json @@ -439,7 +439,7 @@ } } }, - "revision": "20210408", + "revision": "20210422", "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 47ca720a387..ed947317307 100644 --- a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +++ b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json @@ -471,7 +471,7 @@ } } }, - "revision": "20210408", + "revision": "20210422", "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 e5273c4ceff..d5a739b3ca9 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1.json @@ -1312,7 +1312,7 @@ } } }, - "revision": "20210408", + "revision": "20210420", "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 8fbcfe43b85..7a192ed90fe 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1beta.json @@ -161,7 +161,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1312,7 +1312,7 @@ } } }, - "revision": "20210325", + "revision": "20210420", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/genomics.v1.json b/googleapiclient/discovery_cache/documents/genomics.v1.json index 421408283df..5fb5d4f3542 100644 --- a/googleapiclient/discovery_cache/documents/genomics.v1.json +++ b/googleapiclient/discovery_cache/documents/genomics.v1.json @@ -209,7 +209,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -389,7 +389,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", diff --git a/googleapiclient/discovery_cache/documents/genomics.v1alpha2.json b/googleapiclient/discovery_cache/documents/genomics.v1alpha2.json index 39888578e97..116fb93b03d 100644 --- a/googleapiclient/discovery_cache/documents/genomics.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/genomics.v1alpha2.json @@ -389,7 +389,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -675,7 +675,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", @@ -1163,7 +1163,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", diff --git a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json index 3799bbc6c56..55ac3f71db2 100644 --- a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json @@ -301,7 +301,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "Accelerator": { @@ -335,6 +335,10 @@ "$ref": "Secret", "description": "If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys." }, + "encryptedEnvironment": { + "$ref": "Secret", + "description": "The encrypted environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field." + }, "entrypoint": { "description": "If specified, overrides the `ENTRYPOINT` specified in the container.", "type": "string" @@ -713,7 +717,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", @@ -980,6 +984,10 @@ }, "type": "array" }, + "encryptedEnvironment": { + "$ref": "Secret", + "description": "The encrypted environment to pass into every action. Each action can also specify its own encrypted environment. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the `environment` field." + }, "environment": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 81292cd095f..551f27df996 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -631,7 +631,7 @@ } } }, - "revision": "20210409", + "revision": "20210416", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 4b9751f6e09..4bd7b10d6b1 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -678,7 +678,7 @@ } } }, - "revision": "20210409", + "revision": "20210416", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1533,7 +1533,7 @@ "additionalProperties": { "$ref": "MembershipFeatureSpec" }, - "description": "Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.", + "description": "Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.", "type": "object" }, "membershipStates": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json index 036732e9877..555d7e81a6a 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json @@ -652,7 +652,7 @@ } } }, - "revision": "20210409", + "revision": "20210416", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index e8da83d8353..e80f4cc6814 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -678,7 +678,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1511,7 +1511,7 @@ "additionalProperties": { "$ref": "MembershipFeatureSpec" }, - "description": "Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.", + "description": "Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.", "type": "object" }, "membershipStates": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index 12738620742..5b2a831fb3c 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -706,7 +706,7 @@ } } }, - "revision": "20210409", + "revision": "20210416", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index b4db8bfa716..392e562531f 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -2682,7 +2682,7 @@ } } }, - "revision": "20210405", + "revision": "20210419", "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 47ef8ea3aff..833f99d40d8 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "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 9d7305106cf..ea55f78296c 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json index dc4b45e5034..9c8b1190d9b 100644 --- a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20210405", + "revision": "20210417", "rootUrl": "https://groupsmigration.googleapis.com/", "schemas": { "Groups": { diff --git a/googleapiclient/discovery_cache/documents/groupssettings.v1.json b/googleapiclient/discovery_cache/documents/groupssettings.v1.json index 875ee8d1935..b9ecf1639e4 100644 --- a/googleapiclient/discovery_cache/documents/groupssettings.v1.json +++ b/googleapiclient/discovery_cache/documents/groupssettings.v1.json @@ -152,7 +152,7 @@ } } }, - "revision": "20210406", + "revision": "20210415", "rootUrl": "https://www.googleapis.com/", "schemas": { "Groups": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 33db8857fc6..bc5617270f5 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -2032,7 +2032,7 @@ "studies": { "methods": { "delete": { - "description": "DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a study while a delete operation is running for that study could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.delete", @@ -2236,7 +2236,7 @@ "series": { "methods": { "delete": { - "description": "DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a series while a delete operation is running for that series could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.delete", @@ -3916,7 +3916,7 @@ } } }, - "revision": "20210325", + "revision": "20210414", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -4714,6 +4714,10 @@ "description": "Represents a FHIR store.", "id": "FhirStore", "properties": { + "defaultSearchHandlingStrict": { + "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", + "type": "boolean" + }, "disableReferentialIntegrity": { "description": "Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.", "type": "boolean" @@ -4925,7 +4929,7 @@ "description": "The configuration for the exported BigQuery schema." }, "writeDisposition": { - "description": "Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored.", + "description": "Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_EMPTY", diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 57427481b51..065563317ed 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -2539,7 +2539,7 @@ "studies": { "methods": { "delete": { - "description": "DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: If you insert instances into a study while a delete operation is running for that study, the instances you insert might not appear in search results until after the deletion operation finishes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.delete", @@ -2743,7 +2743,7 @@ "series": { "methods": { "delete": { - "description": "DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: If you insert instances into a series while a delete operation is running for that series, the instances you insert might not appear in search results until after the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.delete", @@ -4837,7 +4837,7 @@ } } }, - "revision": "20210325", + "revision": "20210414", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -6243,7 +6243,7 @@ "type": "string" }, "writeDisposition": { - "description": "Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored.", + "description": "Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_EMPTY", @@ -6409,7 +6409,7 @@ "description": "The configuration for the exported BigQuery schema." }, "writeDisposition": { - "description": "Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored.", + "description": "Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_EMPTY", diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index 2a681caf240..5863022758e 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "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 616823f28e6..5ef740d841a 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -1696,7 +1696,7 @@ } } }, - "revision": "20210331", + "revision": "20210406", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AdminAuditData": { diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index be5cf408529..3745591e43b 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -226,7 +226,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json index 720bbfcf310..1fd2ba64cd7 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1.json @@ -487,7 +487,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1beta1.json b/googleapiclient/discovery_cache/documents/iap.v1beta1.json index 1b66ae51783..15c4d75c044 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1beta1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://iap.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/indexing.v3.json b/googleapiclient/discovery_cache/documents/indexing.v3.json index 2503234f206..8d1c2fadb9a 100644 --- a/googleapiclient/discovery_cache/documents/indexing.v3.json +++ b/googleapiclient/discovery_cache/documents/indexing.v3.json @@ -149,7 +149,7 @@ } } }, - "revision": "20210401", + "revision": "20210420", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v3.json b/googleapiclient/discovery_cache/documents/jobs.v3.json index a4995e77e90..95f5fa8ef58 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" }, "https://www.googleapis.com/auth/jobs": { "description": "Manage job postings" @@ -651,7 +651,7 @@ } } }, - "revision": "20210309", + "revision": "20210415", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -1489,7 +1489,7 @@ "id": "Job", "properties": { "addresses": { - "description": "Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.", + "description": "Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses \"1600 Amphitheatre Parkway, Mountain View, CA, USA\" and \"London, UK\" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json index b0ee9651196..9b8dbbffcde 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" }, "https://www.googleapis.com/auth/jobs": { "description": "Manage job postings" @@ -681,7 +681,7 @@ } } }, - "revision": "20210309", + "revision": "20210415", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -1471,7 +1471,7 @@ "id": "HistogramQuery", "properties": { "histogramQuery": { - "description": "An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like \"any string with backslash escape for quote(\\\").\" * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and [\"one\", \"two\", \"three\"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, \"positive number\") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, \"FULL_TIME\", \"PART_TIME\". * company_size: histogram by CompanySize, for example, \"SMALL\", \"MEDIUM\", \"BIG\". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, \"Bachelors\", \"Masters\". * job_level: histogram by the Job.job_level. For example, \"Entry Level\". * country: histogram by the country code of jobs. For example, \"US\", \"FR\". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, \"CA\", \"IL\". * city: histogram by a combination of the \"city name, admin1 code\". For example, \"Mountain View, CA\", \"New York, NY\". * admin1_country: histogram by a combination of the \"admin1 code, country\". For example, \"CA, US\", \"IL, US\". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, \"en-US\", \"fr-FR\". * language: histogram by the language subtag of the Job.language_code. For example, \"en\", \"fr\". * category: histogram by the JobCategory. For example, \"COMPUTER_AND_IT\", \"HEALTHCARE\". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, \"WEEKLY\", \"MONTHLY\". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute[\"key1\"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute[\"key1\"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute[\"some-string-custom-attribute\"]) * count(numeric_custom_attribute[\"some-numeric-custom-attribute\"], [bucket(MIN, 0, \"negative\"), bucket(0, MAX, \"non-negative\"])", + "description": "An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like \"any string with backslash escape for quote(\\\").\" * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and [\"one\", \"two\", \"three\"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, \"positive number\") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, \"FULL_TIME\", \"PART_TIME\". * company_size: histogram by CompanySize, for example, \"SMALL\", \"MEDIUM\", \"BIG\". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, \"Bachelors\", \"Masters\". * job_level: histogram by the Job.job_level. For example, \"Entry Level\". * country: histogram by the country code of jobs. For example, \"US\", \"FR\". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, \"CA\", \"IL\". * city: histogram by a combination of the \"city name, admin1 code\". For example, \"Mountain View, CA\", \"New York, NY\". * admin1_country: histogram by a combination of the \"admin1 code, country\". For example, \"CA, US\", \"IL, US\". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, \"en-US\", \"fr-FR\". * language: histogram by the language subtag of the Job.language_code. For example, \"en\", \"fr\". * category: histogram by the JobCategory. For example, \"COMPUTER_AND_IT\", \"HEALTHCARE\". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, \"WEEKLY\", \"MONTHLY\". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute[\"key1\"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute[\"key1\"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute[\"some-string-custom-attribute\"]) * count(numeric_custom_attribute[\"some-numeric-custom-attribute\"], [bucket(MIN, 0, \"negative\"), bucket(0, MAX, \"non-negative\")])", "type": "string" } }, @@ -1586,7 +1586,7 @@ "id": "Job", "properties": { "addresses": { - "description": "Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.", + "description": "Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses \"1600 Amphitheatre Parkway, Mountain View, CA, USA\" and \"London, UK\" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/jobs.v4.json b/googleapiclient/discovery_cache/documents/jobs.v4.json index 8dc1ae40466..b85e876b6c7 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v4.json +++ b/googleapiclient/discovery_cache/documents/jobs.v4.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" }, "https://www.googleapis.com/auth/jobs": { "description": "Manage job postings" @@ -903,7 +903,7 @@ } } }, - "revision": "20210309", + "revision": "20210415", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -1633,7 +1633,7 @@ "id": "Job", "properties": { "addresses": { - "description": "Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.", + "description": "Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses \"1600 Amphitheatre Parkway, Mountain View, CA, USA\" and \"London, UK\" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500.", "items": { "type": "string" }, @@ -2748,7 +2748,7 @@ "type": "boolean" }, "histogramQueries": { - "description": "An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like \"any string with backslash escape for quote(\\\").\" * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and [\"one\", \"two\", \"three\"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, \"positive number\") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, \"FULL_TIME\", \"PART_TIME\". * company_size: histogram by CompanySize, for example, \"SMALL\", \"MEDIUM\", \"BIG\". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, \"Bachelors\", \"Masters\". * job_level: histogram by the Job.job_level, for example, \"Entry Level\". * country: histogram by the country code of jobs, for example, \"US\", \"FR\". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, \"CA\", \"IL\". * city: histogram by a combination of the \"city name, admin1 code\". For example, \"Mountain View, CA\", \"New York, NY\". * admin1_country: histogram by a combination of the \"admin1 code, country\", for example, \"CA, US\", \"IL, US\". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, \"en-US\", \"fr-FR\". * language: histogram by the language subtag of the Job.language_code, for example, \"en\", \"fr\". * category: histogram by the JobCategory, for example, \"COMPUTER_AND_IT\", \"HEALTHCARE\". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, \"WEEKLY\", \"MONTHLY\". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute[\"key1\"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute[\"key1\"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute[\"some-string-custom-attribute\"])` * `count(numeric_custom_attribute[\"some-numeric-custom-attribute\"], [bucket(MIN, 0, \"negative\"), bucket(0, MAX, \"non-negative\"])`", + "description": "An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like \"any string with backslash escape for quote(\\\").\" * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and [\"one\", \"two\", \"three\"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, \"positive number\") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, \"FULL_TIME\", \"PART_TIME\". * company_size: histogram by CompanySize, for example, \"SMALL\", \"MEDIUM\", \"BIG\". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, \"Bachelors\", \"Masters\". * job_level: histogram by the Job.job_level, for example, \"Entry Level\". * country: histogram by the country code of jobs, for example, \"US\", \"FR\". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, \"CA\", \"IL\". * city: histogram by a combination of the \"city name, admin1 code\". For example, \"Mountain View, CA\", \"New York, NY\". * admin1_country: histogram by a combination of the \"admin1 code, country\", for example, \"CA, US\", \"IL, US\". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, \"en-US\", \"fr-FR\". * language: histogram by the language subtag of the Job.language_code, for example, \"en\", \"fr\". * category: histogram by the JobCategory, for example, \"COMPUTER_AND_IT\", \"HEALTHCARE\". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, \"WEEKLY\", \"MONTHLY\". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute[\"key1\"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute[\"key1\"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute[\"some-string-custom-attribute\"])` * `count(numeric_custom_attribute[\"some-numeric-custom-attribute\"], [bucket(MIN, 0, \"negative\"), bucket(0, MAX, \"non-negative\")])`", "items": { "$ref": "HistogramQuery" }, diff --git a/googleapiclient/discovery_cache/documents/language.v1.json b/googleapiclient/discovery_cache/documents/language.v1.json index 72f563d0865..4381058808c 100644 --- a/googleapiclient/discovery_cache/documents/language.v1.json +++ b/googleapiclient/discovery_cache/documents/language.v1.json @@ -227,7 +227,7 @@ } } }, - "revision": "20210326", + "revision": "20210417", "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 687e35d91fd..87ce1d2ef88 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta1.json @@ -189,7 +189,7 @@ } } }, - "revision": "20210326", + "revision": "20210417", "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 4b867ed1e9b..5d94e971d05 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta2.json @@ -227,7 +227,7 @@ } } }, - "revision": "20210326", + "revision": "20210417", "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 05b866f9900..2ef6c7f5f34 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "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 c16abb7bd68..8bc668e6b7a 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20210410", + "revision": "20210423", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json index 26de0b61d0b..62e0fbb71fa 100644 --- a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +++ b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json @@ -312,7 +312,7 @@ } } }, - "revision": "20210408", + "revision": "20210417", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { @@ -649,7 +649,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index 517312018fa..b3efa03c264 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "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 09825611088..2bf03cd8903 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -398,7 +398,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -743,7 +743,7 @@ ], "parameters": { "logName": { - "description": "Required. The resource name of the log to delete: \"projects/[PROJECT_ID]/logs/[LOG_ID]\" \"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\" \"folders/[FOLDER_ID]/logs/[LOG_ID]\" [LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "description": "Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\".For more information about log names, see LogEntry.", "location": "path", "pattern": "^billingAccounts/[^/]+/logs/[^/]+$", "required": true, @@ -780,14 +780,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name that owns the logs: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" ", + "description": "Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "path", "pattern": "^billingAccounts/[^/]+$", "required": true, "type": "string" }, "resourceNames": { - "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "description": "Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "query", "repeated": true, "type": "string" @@ -1461,7 +1461,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1862,7 +1862,7 @@ ], "parameters": { "logName": { - "description": "Required. The resource name of the log to delete: \"projects/[PROJECT_ID]/logs/[LOG_ID]\" \"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\" \"folders/[FOLDER_ID]/logs/[LOG_ID]\" [LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "description": "Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\".For more information about log names, see LogEntry.", "location": "path", "pattern": "^folders/[^/]+/logs/[^/]+$", "required": true, @@ -1899,14 +1899,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name that owns the logs: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" ", + "description": "Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "path", "pattern": "^folders/[^/]+$", "required": true, "type": "string" }, "resourceNames": { - "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "description": "Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "query", "repeated": true, "type": "string" @@ -2190,7 +2190,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -2591,7 +2591,7 @@ ], "parameters": { "logName": { - "description": "Required. The resource name of the log to delete: \"projects/[PROJECT_ID]/logs/[LOG_ID]\" \"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\" \"folders/[FOLDER_ID]/logs/[LOG_ID]\" [LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "description": "Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\".For more information about log names, see LogEntry.", "location": "path", "pattern": "^[^/]+/[^/]+/logs/[^/]+$", "required": true, @@ -2628,14 +2628,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name that owns the logs: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" ", + "description": "Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, "type": "string" }, "resourceNames": { - "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "description": "Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "query", "repeated": true, "type": "string" @@ -2968,7 +2968,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -3369,7 +3369,7 @@ ], "parameters": { "logName": { - "description": "Required. The resource name of the log to delete: \"projects/[PROJECT_ID]/logs/[LOG_ID]\" \"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\" \"folders/[FOLDER_ID]/logs/[LOG_ID]\" [LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "description": "Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\".For more information about log names, see LogEntry.", "location": "path", "pattern": "^organizations/[^/]+/logs/[^/]+$", "required": true, @@ -3406,14 +3406,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name that owns the logs: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" ", + "description": "Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, "resourceNames": { - "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "description": "Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "query", "repeated": true, "type": "string" @@ -3860,7 +3860,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -4261,7 +4261,7 @@ ], "parameters": { "logName": { - "description": "Required. The resource name of the log to delete: \"projects/[PROJECT_ID]/logs/[LOG_ID]\" \"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\" \"folders/[FOLDER_ID]/logs/[LOG_ID]\" [LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "description": "Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\".For more information about log names, see LogEntry.", "location": "path", "pattern": "^projects/[^/]+/logs/[^/]+$", "required": true, @@ -4298,14 +4298,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name that owns the logs: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" ", + "description": "Required. The resource name that owns the logs: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "resourceNames": { - "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "description": "Optional. The resource name that owns the logs: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]", "location": "query", "repeated": true, "type": "string" @@ -4934,7 +4934,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryOptions": { @@ -5242,7 +5242,7 @@ "type": "array" }, "resourceNames": { - "description": "Required. Names of one or more parent resources from which to retrieve log entries: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" May alternatively be one or more views projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDProjects listed in the project_ids field are added to this list.", + "description": "Required. Names of one or more parent resources from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]Projects listed in the project_ids field are added to this list.", "items": { "type": "string" }, @@ -5431,6 +5431,13 @@ "readOnly": true, "type": "string" }, + "restrictedFields": { + "description": "Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation. Restricting a repeated field will restrict all values. Adding a parent will block all child fields e.g. foo.bar will block foo.bar.baz.", + "items": { + "type": "string" + }, + "type": "array" + }, "retentionDays": { "description": "Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.", "format": "int32", @@ -6318,7 +6325,7 @@ "type": "string" }, "resourceNames": { - "description": "Required. Name of a parent resource from which to retrieve log entries: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" May alternatively be one or more views: \"projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\" \"organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\" \"billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\" \"folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\"", + "description": "Required. Name of a parent resource from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]", "items": { "type": "string" }, @@ -6377,7 +6384,7 @@ "type": "object" }, "logName": { - "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: \"projects/[PROJECT_ID]/logs/[LOG_ID]\" \"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\" \"folders/[FOLDER_ID]/logs/[LOG_ID]\" [LOG_ID] must be URL-encoded. For example: \"projects/my-project-id/logs/syslog\" \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\" The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.", + "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example: \"projects/my-project-id/logs/syslog\" \"organizations/123/logs/cloudaudit.googleapis.com%2Factivity\" The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.", "type": "string" }, "partialSuccess": { diff --git a/googleapiclient/discovery_cache/documents/manufacturers.v1.json b/googleapiclient/discovery_cache/documents/manufacturers.v1.json index db348230afa..b669f8b2f83 100644 --- a/googleapiclient/discovery_cache/documents/manufacturers.v1.json +++ b/googleapiclient/discovery_cache/documents/manufacturers.v1.json @@ -287,7 +287,7 @@ } } }, - "revision": "20210407", + "revision": "20210421", "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 0a89d277359..ac77447d508 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -528,7 +528,7 @@ } } }, - "revision": "20210401", + "revision": "20210413", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -798,7 +798,7 @@ "id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule", "properties": { "canReschedule": { - "description": "This field will be deprecated, and will be always set to true since reschedule can happen multiple times now.", + "description": "This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.", "type": "boolean" }, "endTime": { @@ -1054,6 +1054,7 @@ "STATE_UNSPECIFIED", "CREATING", "READY", + "UPDATING", "DELETING", "PERFORMING_MAINTENANCE" ], @@ -1061,6 +1062,7 @@ "State not set.", "Memcached instance is being created.", "Memcached instance has been created and ready to be used.", + "Memcached instance is updating configuration such as maintenance policy and schedule.", "Memcached instance is being deleted.", "Memcached instance is going through maintenance, e.g. data plane rollout." ], diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json index 2bab0f7fc81..4de5170d222 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json @@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" } } } @@ -556,7 +556,7 @@ } } }, - "revision": "20210401", + "revision": "20210413", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -844,7 +844,7 @@ "id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule", "properties": { "canReschedule": { - "description": "This field will be deprecated, and will be always set to true since reschedule can happen multiple times now.", + "description": "This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.", "type": "boolean" }, "endTime": { @@ -1100,6 +1100,7 @@ "STATE_UNSPECIFIED", "CREATING", "READY", + "UPDATING", "DELETING", "PERFORMING_MAINTENANCE" ], @@ -1107,6 +1108,7 @@ "State not set.", "Memcached instance is being created.", "Memcached instance has been created and ready to be used.", + "Memcached instance is updating configuration such as maintenance policy and schedule.", "Memcached instance is being deleted.", "Memcached instance is going through maintenance, e.g. data plane rollout." ], diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index 60cd788247e..75877865892 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -600,7 +600,7 @@ "backups": { "methods": { "create": { - "description": "Creates a new Backup in a given project and location.", + "description": "Creates a new backup in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups", "httpMethod": "POST", "id": "metastore.projects.locations.services.backups.create", @@ -899,7 +899,7 @@ } } }, - "revision": "20210325", + "revision": "20210413", "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 cfbb2235420..92ec95fc343 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -600,7 +600,7 @@ "backups": { "methods": { "create": { - "description": "Creates a new Backup in a given project and location.", + "description": "Creates a new backup in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups", "httpMethod": "POST", "id": "metastore.projects.locations.services.backups.create", @@ -899,7 +899,7 @@ } } }, - "revision": "20210325", + "revision": "20210413", "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 ac8b1d1180f..05799af37f9 100644 --- a/googleapiclient/discovery_cache/documents/ml.v1.json +++ b/googleapiclient/discovery_cache/documents/ml.v1.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20210409", + "revision": "20210412", "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 4adb207e939..fb91d3da8d8 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -275,7 +275,7 @@ } } }, - "revision": "20210409", + "revision": "20210417", "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 f193fd8e1a2..36e2e5bccf3 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2541,7 +2541,7 @@ } } }, - "revision": "20210409", + "revision": "20210417", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -3005,8 +3005,8 @@ "No content matcher type specified (maintained for backward compatibility, but deprecated for future use). Treated as CONTAINS_STRING.", "Selects substring matching. The match succeeds if the output contains the content string. This is the default value for checks without a matcher option, or where the value of matcher is CONTENT_MATCHER_OPTION_UNSPECIFIED.", "Selects negation of substring matching. The match succeeds if the output does NOT contain the content string.", - "Selects regular-expression matching. The match succeeds of the output matches the regular expression specified in the content string.", - "Selects negation of regular-expression matching. The match succeeds if the output does NOT match the regular expression specified in the content string." + "Selects regular-expression matching. The match succeeds of the output matches the regular expression specified in the content string. Regex matching is only supported for HTTP/HTTPS checks.", + "Selects negation of regular-expression matching. The match succeeds if the output does NOT match the regular expression specified in the content string. Regex matching is only supported for HTTP/HTTPS checks." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index dcf3e00ae1b..36d41e15565 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -528,7 +528,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index faea06a9efe..18d7b1b5363 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 90bd9d5d515..e00eee977bd 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -591,7 +591,7 @@ } } }, - "revision": "20210401", + "revision": "20210422", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -611,7 +611,11 @@ "NO_EXTERNAL_IP", "UNINTENDED_DESTINATION", "TRACE_TOO_LONG", - "INTERNAL_ERROR" + "INTERNAL_ERROR", + "SOURCE_ENDPOINT_NOT_FOUND", + "MISMATCHED_SOURCE_NETWORK", + "DESTINATION_ENDPOINT_NOT_FOUND", + "MISMATCHED_DESTINATION_NETWORK" ], "enumDescriptions": [ "Cause is unspecified.", @@ -624,7 +628,11 @@ "Aborted because traffic is sent from a public IP to an instance without an external IP.", "Aborted because none of the traces matches destination information specified in the input test request.", "Aborted because the number of steps in the trace exceeding a certain limit which may be caused by routing loop.", - "Aborted due to internal server error." + "Aborted due to internal server error.", + "Aborted because the source endpoint could not be found.", + "Aborted because the source network does not match the source endpoint.", + "Aborted because the destination endpoint could not be found.", + "Aborted because the destination network does not match the destination endpoint." ], "type": "string" }, @@ -711,6 +719,37 @@ "properties": {}, "type": "object" }, + "CloudSQLInstanceInfo": { + "description": "For display only. Metadata associated with a Cloud SQL instance.", + "id": "CloudSQLInstanceInfo", + "properties": { + "displayName": { + "description": "Name of a Cloud SQL instance.", + "type": "string" + }, + "externalIp": { + "description": "External IP address of Cloud SQL instance.", + "type": "string" + }, + "internalIp": { + "description": "Internal IP address of Cloud SQL instance.", + "type": "string" + }, + "networkUri": { + "description": "URI of a Cloud SQL instance network or empty string if instance does not have one.", + "type": "string" + }, + "region": { + "description": "Region in which the Cloud SQL instance is running.", + "type": "string" + }, + "uri": { + "description": "URI of a Cloud SQL instance.", + "type": "string" + } + }, + "type": "object" + }, "ConnectivityTest": { "description": "A Connectivity Test for a network reachability analysis.", "id": "ConnectivityTest", @@ -788,13 +827,17 @@ "TARGET_UNSPECIFIED", "INSTANCE", "INTERNET", - "GOOGLE_API" + "GOOGLE_API", + "GKE_MASTER", + "CLOUD_SQL_INSTANCE" ], "enumDescriptions": [ "Target not specified.", "Target is a Compute Engine instance.", "Target is the Internet.", - "Target is a Google API." + "Target is a Google API.", + "Target is a Google Kubernetes Engine cluster master.", + "Target is a Cloud SQL instance." ], "type": "string" } @@ -824,26 +867,36 @@ "FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK", "INSTANCE_NOT_RUNNING", "TRAFFIC_TYPE_BLOCKED", - "GKE_MASTER_UNAUTHORIZED_ACCESS" + "GKE_MASTER_UNAUTHORIZED_ACCESS", + "CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS", + "DROPPED_INSIDE_GKE_SERVICE", + "DROPPED_INSIDE_CLOUD_SQL_SERVICE", + "GOOGLE_MANAGED_SERVICE_NO_PEERING", + "CLOUD_SQL_INSTANCE_NO_IP_ADDRESS" ], "enumDescriptions": [ "Cause is unspecified.", "Destination external address cannot be resolved to a known target. If the address is used in a GCP project, provide the project ID as test input.", - "A Compute Engine instance can send or receive a packet with a foreign IP only if ip_forward is enabled.", + "A Compute Engine instance can only send or receive a packet with a foreign IP if ip_forward is enabled.", "Dropped due to a firewall rule, unless allowed due to connection tracking.", "Dropped due to no routes.", "Dropped due to invalid route. Route's next hop is a blackhole.", "Packet is sent to a wrong (unintended) network. Example: you trace a packet from VM1:Network1 to VM2:Network2, however, the route configured in Network1 sends the packet destined for VM2's IP addresss to Network3.", "Packet with internal destination address sent to Internet gateway.", - "Instance with only an internal IP tries to access Google API and Services, and private Google access is not enabled.", - "Instance with only internal IP tries to access external hosts, but Cloud NAT is not enabled in the subnet, unless special configurations on a VM allows this connection. See [Special Configurations for VM instances](/vpc/docs/special-configurations) for details.", + "Instance with only an internal IP tries to access Google API and Services, but private Google access is not enabled.", + "Instance with only internal IP tries to access external hosts, but Cloud NAT is not enabled in the subnet, unless special configurations on a VM allows this connection. See [Special Configurations for VM instances](https://cloud.google.com/vpc/docs/special-configurations) for more details.", "Destination internal address cannot be resolved to a known target. If this is a shared VPC scenario, verify if the service project ID is provided as test input. Otherwise, verify if the IP address is being used in the project.", "Forwarding rule's protocol and ports do not match the packet header.", "Forwarding rule does not have backends configured.", - "Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. See [Health check firewall rules](/load-balancing/docs/health-checks#firewall_rules) for more details.", + "Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. See [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules) for more details.", "Packet is sent from or to a Compute Engine instance that is not in a running state.", - "The type of traffic is blocked and the user cannot configure a firewall rule to enable it. See [Always blocked traffic](/vpc/docs/firewalls#blockedtraffic) for more details.", - "Access to GKE master's endpoint is not authorized. See [Access to the cluster endpoints](/docs/how-to/private-clusters#access_to_the_cluster_endpoints) for more details." + "The type of traffic is blocked and the user cannot configure a firewall rule to enable it. See [Always blocked traffic](https://cloud.google.com/vpc/docs/firewalls#blockedtraffic) for more details.", + "Access to Google Kubernetes Engine cluster master's endpoint is not authorized. See [Access to the cluster endpoints](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints) for more details.", + "Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.", + "Packet was dropped inside Google Kubernetes Engine Service.", + "Packet was dropped inside Cloud SQL Service.", + "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", + "Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address." ], "type": "string" }, @@ -1044,7 +1097,8 @@ "VPN_GATEWAY", "INTERCONNECT", "GKE_MASTER", - "IMPORTED_CUSTOM_ROUTE_NEXT_HOP" + "IMPORTED_CUSTOM_ROUTE_NEXT_HOP", + "CLOUD_SQL_INSTANCE" ], "enumDescriptions": [ "Target not specified.", @@ -1052,7 +1106,8 @@ "Forwarded to a Cloud VPN gateway.", "Forwarded to a Cloud Interconnect connection.", "Forwarded to a Google Kubernetes Engine Container cluster master.", - "Forwarded to the next hop of a custom route imported from a peering VPC." + "Forwarded to the next hop of a custom route imported from a peering VPC.", + "Forwarded to a Cloud SQL Instance." ], "type": "string" } @@ -1094,6 +1149,29 @@ }, "type": "object" }, + "GKEMasterInfo": { + "description": "For display only. Metadata associated with a Google Kubernetes Engine cluster master.", + "id": "GKEMasterInfo", + "properties": { + "clusterNetworkUri": { + "description": "URI of a Google Kubernetes Engine cluster network.", + "type": "string" + }, + "clusterUri": { + "description": "URI of a Google Kubernetes Engine cluster.", + "type": "string" + }, + "externalIp": { + "description": "External IP address of a Google Kubernetes Engine cluster master.", + "type": "string" + }, + "internalIp": { + "description": "Internal IP address of a Google Kubernetes Engine cluster master.", + "type": "string" + } + }, + "type": "object" + }, "InstanceInfo": { "description": "For display only. Metadata associated with a Compute Engine instance.", "id": "InstanceInfo", @@ -1549,7 +1627,7 @@ "Next hop is a peering VPC.", "Next hop is an interconnect.", "Next hop is a VPN tunnel.", - "Next hop is a VPN Gateway. This scenario happens only when tracing connectivity from an on-premises network to GCP through a VPN. The analysis simulates a packet departing from the on-premises network through a VPN tunnel and arriving at a Cloud VPN gateway.", + "Next hop is a VPN Gateway. This scenario only happens when tracing connectivity from an on-premises network to GCP through a VPN. The analysis simulates a packet departing from the on-premises network through a VPN tunnel and arriving at a Cloud VPN gateway.", "Next hop is an internet gateway.", "Next hop is blackhole; that is, the next hop either does not exist or is not running.", "Next hop is the forwarding rule of an Internal Load Balancer." @@ -1575,7 +1653,7 @@ "enumDescriptions": [ "Unspecified type. Default value.", "Route is a subnet route automatically created by the system.", - "Static route created by the user, including the default route to the Internet.", + "Static route created by the user including the default route to the Internet.", "Dynamic route exchanged between BGP peers.", "A subnet route received from peering network.", "A static route received from peering network.", @@ -1645,6 +1723,10 @@ "description": "This is a step that leads to the final state Drop.", "type": "boolean" }, + "cloudSqlInstance": { + "$ref": "CloudSQLInstanceInfo", + "description": "Display info of a Cloud SQL instance." + }, "deliver": { "$ref": "DeliverInfo", "description": "Display info of the final state \"deliver\" and reason." @@ -1673,6 +1755,10 @@ "$ref": "ForwardingRuleInfo", "description": "Display info of a Compute Engine forwarding rule." }, + "gkeMaster": { + "$ref": "GKEMasterInfo", + "description": "Display info of a Google Kubernetes Engine cluster master." + }, "instance": { "$ref": "InstanceInfo", "description": "Display info of a Compute Engine instance." @@ -1700,6 +1786,8 @@ "START_FROM_INSTANCE", "START_FROM_INTERNET", "START_FROM_PRIVATE_NETWORK", + "START_FROM_GKE_MASTER", + "START_FROM_CLOUD_SQL_INSTANCE", "APPLY_INGRESS_FIREWALL_RULE", "APPLY_EGRESS_FIREWALL_RULE", "APPLY_ROUTE", @@ -1723,6 +1811,8 @@ "Initial state: packet originating from a Compute Engine instance. An InstanceInfo will be populated with starting instance info.", "Initial state: packet originating from Internet. The endpoint info will be populated.", "Initial state: packet originating from a VPC or on-premises network with internal source IP. If the source is a VPC network visible to the user, a NetworkInfo will be populated with details of the network.", + "Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo will be populated with starting instance info.", + "Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo will be populated with starting instance info.", "Config checking state: verify ingress firewall rule.", "Config checking state: verify egress firewall rule.", "Config checking state: verify route.", @@ -1736,7 +1826,7 @@ "Transition state: packet header translated.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", - "Final state: packet coud be dropped.", + "Final state: packet could be dropped.", "Final state: packet could be forwarded to a network with an unknown configuration.", "Final state: analysis is aborted.", "Special state: viewer of the test result does not have permission to see the configuration in this step." @@ -1783,7 +1873,7 @@ "type": "object" }, "Trace": { - "description": "Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```", + "description": "Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```", "id": "Trace", "properties": { "endpointInfo": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index ab145e17186..ffa47a0f1b7 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -591,7 +591,7 @@ } } }, - "revision": "20210401", + "revision": "20210422", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -900,8 +900,8 @@ "Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.", "Packet was dropped inside Google Kubernetes Engine Service.", "Packet was dropped inside Cloud SQL Service.", - "Packet was dropped as there is no peering between the originating network and the Google Managed Services Network.", - "Packet was dropped because Cloud SQL instance has neither private nor public IP address." + "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", + "Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address." ], "type": "string" }, @@ -1983,7 +1983,7 @@ "type": "object" }, "Trace": { - "description": "Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered Steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```", + "description": "Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```", "id": "Trace", "properties": { "endpointInfo": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index 53e784dcb4f..e8be247564c 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1553,7 +1553,7 @@ } } }, - "revision": "20210402", + "revision": "20210417", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index a0bb219b2d4..b3dfd40ce96 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1119,8 +1119,7 @@ "description": "The package being analysed for vulnerabilities", "type": "string" }, - "projectId": { - "description": "The projectId of the package to which this data belongs. Most of Drydock's code does not set or use this field. This is added specifically so we can group packages by projects and decide whether or not to apply NVD data to the packages belonging to a specific project.", + "unused": { "type": "string" }, "version": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index b42d2e668f8..5d73e7d9a5d 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1119,8 +1119,7 @@ "description": "The package being analysed for vulnerabilities", "type": "string" }, - "projectId": { - "description": "The projectId of the package to which this data belongs. Most of Drydock's code does not set or use this field. This is added specifically so we can group packages by projects and decide whether or not to apply NVD data to the packages belonging to a specific project.", + "unused": { "type": "string" }, "version": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index 43e4666136e..ca332ff1ea8 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -751,7 +751,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2Constraint": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index 102c6e2094c..257bbc25cef 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -14,7 +14,7 @@ "canonicalName": "OS Config", "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/compute/docs/manage-os", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -127,7 +127,10 @@ "path": "v1/{+name}", "response": { "$ref": "Empty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", @@ -165,7 +168,10 @@ "path": "v1/{+name}", "response": { "$ref": "ListOperationsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -470,7 +476,7 @@ } } }, - "revision": "20210405", + "revision": "20210421", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -1025,6 +1031,61 @@ }, "type": "object" }, + "OSPolicyAssignmentOperationMetadata": { + "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", + "id": "OSPolicyAssignmentOperationMetadata", + "properties": { + "apiMethod": { + "description": "The OS policy assignment API method.", + "enum": [ + "API_METHOD_UNSPECIFIED", + "CREATE", + "UPDATE", + "DELETE" + ], + "enumDescriptions": [ + "Invalid value", + "Create OS policy assignment API method", + "Update OS policy assignment API method", + "Delete OS policy assignment API method" + ], + "type": "string" + }, + "osPolicyAssignment": { + "description": "Reference to the `OSPolicyAssignment` API resource. Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}", + "type": "string" + }, + "rolloutStartTime": { + "description": "Rollout start time", + "format": "google-datetime", + "type": "string" + }, + "rolloutState": { + "description": "State of the rollout", + "enum": [ + "ROLLOUT_STATE_UNSPECIFIED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Invalid value", + "The rollout is in progress.", + "The rollout is being cancelled.", + "The rollout is cancelled.", + "The rollout has completed successfully." + ], + "type": "string" + }, + "rolloutUpdateTime": { + "description": "Rollout update time", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "OneTimeSchedule": { "description": "Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "id": "OneTimeSchedule", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index c7b7e70804f..f4e10f09da6 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -14,7 +14,7 @@ "canonicalName": "OS Config", "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/compute/docs/manage-os", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -599,7 +599,7 @@ } } }, - "revision": "20210405", + "revision": "20210421", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -1146,6 +1146,61 @@ }, "type": "object" }, + "OSPolicyAssignmentOperationMetadata": { + "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", + "id": "OSPolicyAssignmentOperationMetadata", + "properties": { + "apiMethod": { + "description": "The OS policy assignment API method.", + "enum": [ + "API_METHOD_UNSPECIFIED", + "CREATE", + "UPDATE", + "DELETE" + ], + "enumDescriptions": [ + "Invalid value", + "Create OS policy assignment API method", + "Update OS policy assignment API method", + "Delete OS policy assignment API method" + ], + "type": "string" + }, + "osPolicyAssignment": { + "description": "Reference to the `OSPolicyAssignment` API resource. Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}", + "type": "string" + }, + "rolloutStartTime": { + "description": "Rollout start time", + "format": "google-datetime", + "type": "string" + }, + "rolloutState": { + "description": "State of the rollout", + "enum": [ + "ROLLOUT_STATE_UNSPECIFIED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Invalid value", + "The rollout is in progress.", + "The rollout is being cancelled.", + "The rollout is cancelled.", + "The rollout has completed successfully." + ], + "type": "string" + }, + "rolloutUpdateTime": { + "description": "Rollout update time", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "OneTimeSchedule": { "description": "Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "id": "OneTimeSchedule", diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1.json b/googleapiclient/discovery_cache/documents/oslogin.v1.json index 36a88646f26..e26ac91346e 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1.json @@ -306,7 +306,7 @@ } } }, - "revision": "20210329", + "revision": "20210410", "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 46240b394f6..5ff3189954a 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json @@ -160,7 +160,7 @@ "view": { "description": "The view configures whether to retrieve security keys information.", "enum": [ - "VIEW_UNSPECIFIED", + "LOGIN_PROFILE_VIEW_UNSPECIFIED", "BASIC", "SECURITY_KEY" ], @@ -208,7 +208,7 @@ "view": { "description": "The view configures whether to retrieve security keys information.", "enum": [ - "VIEW_UNSPECIFIED", + "LOGIN_PROFILE_VIEW_UNSPECIFIED", "BASIC", "SECURITY_KEY" ], @@ -374,7 +374,7 @@ } } }, - "revision": "20210329", + "revision": "20210410", "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 4e28ea66d34..e0ced6aeb15 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1beta.json @@ -314,7 +314,7 @@ } } }, - "revision": "20210329", + "revision": "20210410", "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 08500aad1b8..6ab96108098 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -193,7 +193,7 @@ } } }, - "revision": "20210409", + "revision": "20210426", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index e3a22077ad0..681b4bf4057 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -445,7 +445,7 @@ "parameterOrder": [], "parameters": { "pageSize": { - "description": "Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0.", + "description": "Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 10 will be capped to 10.", "format": "int32", "location": "query", "type": "integer" @@ -853,7 +853,7 @@ "parameterOrder": [], "parameters": { "pageSize": { - "description": "Optional. The number of results to return.", + "description": "Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 10 will be capped to 10.", "format": "int32", "location": "query", "type": "integer" @@ -1154,7 +1154,7 @@ } } }, - "revision": "20210408", + "revision": "20210426", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { @@ -2044,6 +2044,11 @@ "$ref": "Person" }, "type": "array" + }, + "totalSize": { + "description": "The total number of other contacts in the list without pagination.", + "format": "int32", + "type": "integer" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/playablelocations.v3.json b/googleapiclient/discovery_cache/documents/playablelocations.v3.json index acb33722621..357b0128e38 100644 --- a/googleapiclient/discovery_cache/documents/playablelocations.v3.json +++ b/googleapiclient/discovery_cache/documents/playablelocations.v3.json @@ -146,7 +146,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://playablelocations.googleapis.com/", "schemas": { "GoogleMapsPlayablelocationsV3Impression": { @@ -504,7 +504,7 @@ "type": "object" }, "GoogleTypeLatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "GoogleTypeLatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index eb3ffef5a1b..f702eafe094 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index b7177eef902..bb920fa6c9f 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -493,7 +493,7 @@ } } }, - "revision": "20210330", + "revision": "20210424", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1AccessStateDiff": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json index 01ec73efb14..5ab82f0d8b7 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json @@ -493,7 +493,7 @@ } } }, - "revision": "20210330", + "revision": "20210424", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1Replay": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json index 3cfc4d66370..af7815071f3 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20210403", + "revision": "20210423", "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 7c5c05ee5fb..7b46cae7305 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json @@ -128,7 +128,7 @@ } } }, - "revision": "20210403", + "revision": "20210423", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1betaAccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json index ac0272a8358..ab7336e094b 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1254,7 +1254,7 @@ } } }, - "revision": "20210401", + "revision": "20210426", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json index e56ab7c20c1..62fdb573278 100644 --- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json @@ -2484,7 +2484,7 @@ } } }, - "revision": "20210410", + "revision": "20210428", "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 48ac11b9377..4de1e466f28 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1424,7 +1424,7 @@ } } }, - "revision": "20210405", + "revision": "20210420", "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 f077dc34e5a..142cea4e210 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json @@ -457,7 +457,7 @@ } } }, - "revision": "20210329", + "revision": "20210420", "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 0be4ce2c0e4..a09a90e6077 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json @@ -724,7 +724,7 @@ } } }, - "revision": "20210329", + "revision": "20210420", "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 76daf64f74d..cc684287fe3 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -632,7 +632,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "Capacity": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index ec0cee001cd..ff3cab3bab9 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1140,7 +1140,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "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 d38d56132c6..7b3e7328258 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json @@ -178,7 +178,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "BiddingFunction": { @@ -192,6 +192,20 @@ "name": { "description": "The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.", "type": "string" + }, + "type": { + "description": "The type of the bidding function to be created.", + "enum": [ + "FUNCTION_TYPE_UNSPECIFIED", + "TURTLEDOVE_SIMULATION_BIDDING_FUNCTION", + "FLEDGE_BIDDING_FUNCTION" + ], + "enumDescriptions": [ + "Default value that should not be used.", + "Bidding function that can be used by Authorized Buyers in the original TURTLEDOVE simulation. See The function takes in a Javascript object, `inputs`, that contains the following named fields: `openrtbContextualBidRequest` OR `googleContextualBidRequest`, `customContextualSignal`, `interestBasedBidData`, `interestGroupData`, `recentImpressionAges`, and returns the bid price CPM. Example: ``` /* Returns a bid price CPM. * * @param {Object} inputs an object with the * following named fields: * - openrtbContextualBidRequest * OR googleContextualBidRequest * - customContextualSignal * - interestBasedBidData * - interestGroupData * - recentImpressionAges */ function biddingFunction(inputs) { ... return inputs.interestBasedBidData.cpm * inputs.customContextualSignals.placementMultiplier; } ```", + "Buyer's interest group bidding function that can be used by Authorized Buyers in the FLEDGE simulation. See the FLEDGE explainer at https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-device-bidding. The function takes one argument, `inputs`, that contains an object with the following named fields of the form: ``` { \"interestGroup\" : [ { \"buyerCreativeId\": \"...\", # Ad creative ID \"adData\": { # any JSON of your choosing }, \"userBiddingSignals\": { . # any JSON of your choosing } } ], \"auctionSignals\": { \"url: # string, \"slotVisibility\": # enum value, \"slotDimensions\": [ { \"height\": # number value \"width\": # number value } ] }, \"perBuyerSignals\": { # Any JSON }, \"trustedBiddingSignals\": { # Any JSON }, \"browserSignals\": { \"recent_impression_ages_secs: [ # number ] } } ``` `interestGroup`: An object containing a list of `ad` objects, which contain the following named fields: - `buyerCreativeId`: The ad creative ID string. - `adData`: Any JSON value of the bidder's choosing to contain data associated with an ad provided in `BidResponse.ad.adslot.ad_data` for the Google Authorized Buyers protocol and `BidResponse.seatbid.bid.ext.ad_data` for the OpenRTB protocol. - `userBiddingSignals`: Any JSON value of the bidder's choosing containing interest group data that corresponds to user_bidding_signals (as in FLEDGE). This field will be populated from `BidResponse.interest_group_map.user_bidding_signals` for Google Authorized Buyers protocol and `BidResponse.ext.interest_group_map.user_bidding_signals` for the OpenRTB protocol. `auctionSignals`: Contains data from the seller. It corresponds to the auction signals data described in the FLEDGE proposal. It is an object containing the following named fields: - `url`: The string URL of the page with parameters removed. - `slotVisibility`: Enum of one of the following potential values: - NO_DETECTION = 0 - ABOVE_THE_FOLD = 1 - BELOW_THE_FOLD = 2 - `slotDimensions`: A list of objects containing containing width and height pairs in `width` and `height` fields, respectively, from `BidRequest.adslot.width` and `BidRequest.adslot.height` for the Google Authorized Buyers protocol and `BidRequest.imp.banner.format.w` and `BidRequest.imp.banner.format.h` for the OpenRTB protocol. `perBuyerSignals`: The contextual signals from the bid response that are populated in `BidResponse.interest_group_bidding.interest_group_buyers.per_buyer_signals` for the Google Authorized Buyers protocol and `BidResponse.ext.interest_group_bidding.interest_group_buyers.per_buyer_signals` for the OpenRTB protocol. These signals can be of any JSON format of your choosing, however, the buyer's domain name must match between: - the interest group response in `BidResponse.interest_group_map.buyer_domain` for the Google Authorized Buyers protocol or in `BidResponse.ext.interest_group_map.buyer_domain` for the OpenRTB protocol. - the contextual response as a key to the map in `BidResponse.interest_group_bidding.interest_group_buyers` for the Google Authorized Buyers protocol or in `BidResponse.ext.interest_group_bidding.interest_group_buyers` for the OpenRTB protocol. In other words, there must be a match between the buyer domain of the contextual per_buyer_signals and the domain of an interest group. `trustedBiddingSignals`: The trusted bidding signals that corresponds to the trusted_bidding_signals in the FLEDGE proposal. It is provided in the interest group response as `BidResponse.interest_group_map.user_bidding_signals` for the Google Authorized Buyers protocol and `BidResponse.ext.interest_group_map.user_bidding_signals` for the OpenRTB protocol. This field can be any JSON format of your choosing. `browserSignals`: An object of simulated browser-provider signals. It is an object with a single named field, `recent_impression_ages_secs`, that contains a list of estimated number value recent impression ages in seconds for a given interest group. The function returns the string creative ID of the selected ad, the bid price CPM, and (optionally) selected product IDs. Example: ``` function biddingFunction(inputs) { ... return { \"buyerCreativeId\": \"ad_creative_id_1\", \"bidPriceCpm\": 0.3, \"productIds\": [\"product_id_1\", \"product_id_2\", \"product_id_3\"] } } ```" + ], + "type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index 17c67256820..be6de2f0402 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -195,7 +195,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent catalog resource name, such as \"projects/*/locations/global/catalogs/default_catalog\".", + "description": "Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, @@ -223,7 +223,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", + "description": "Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", "required": true, @@ -248,7 +248,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id\".", + "description": "Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", "required": true, @@ -273,7 +273,7 @@ ], "parameters": { "parent": { - "description": "Required. \"projects/1234/locations/global/catalogs/default_catalog\" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.", + "description": "Required. `projects/1234/locations/global/catalogs/default_catalog` If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, @@ -317,7 +317,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent catalog resource name, such as \"projects/*/locations/global/catalogs/default_catalog\".", + "description": "Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, @@ -342,7 +342,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", + "description": "Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", "required": true, @@ -452,7 +452,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard", + "description": "Required. Full resource name of the format: `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}` The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+/placements/[^/]+$", "required": true, @@ -484,7 +484,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource path. \"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -512,7 +512,7 @@ ], "parameters": { "name": { - "description": "Required. The API key to unregister including full resource path. \"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/\"", + "description": "Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+/predictionApiKeyRegistrations/[^/]+$", "required": true, @@ -548,7 +548,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent placement resource name such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\"", + "description": "Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -583,7 +583,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent eventStore name, such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. The parent eventStore name, such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -618,7 +618,7 @@ ], "parameters": { "parent": { - "description": "Required. \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\"", + "description": "Required. `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -662,7 +662,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent eventStore resource name, such as \"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -687,7 +687,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the event_store under which the events are created. The format is \"projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}\"", + "description": "Required. The resource name of the event_store under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -715,7 +715,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of user event, such as \"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. Full resource name of user event, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -842,7 +842,7 @@ } } }, - "revision": "20210326", + "revision": "20210416", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1169,7 +1169,7 @@ "id": "GoogleCloudRecommendationengineV1beta1GcsSource", "properties": { "inputUris": { - "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", + "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index 80147139f8b..a0df6c9b954 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -164,7 +164,7 @@ "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "required": true, @@ -432,7 +432,7 @@ "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "required": true, @@ -700,7 +700,7 @@ "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "required": true, @@ -968,7 +968,7 @@ "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "required": true, @@ -1178,7 +1178,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "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 e4140012034..9ac8552d1c4 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -1178,7 +1178,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "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 63d8cb5b991..249ab33b513 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -596,7 +596,7 @@ } } }, - "revision": "20210402", + "revision": "20210422", "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 0db33381f3d..a3affef80cf 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -596,7 +596,7 @@ } } }, - "revision": "20210402", + "revision": "20210422", "rootUrl": "https://redis.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/remotebuildexecution.v1.json b/googleapiclient/discovery_cache/documents/remotebuildexecution.v1.json index ef4dabcffe9..acf9d929cba 100644 --- a/googleapiclient/discovery_cache/documents/remotebuildexecution.v1.json +++ b/googleapiclient/discovery_cache/documents/remotebuildexecution.v1.json @@ -307,7 +307,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://remotebuildexecution.googleapis.com/", "schemas": { "BuildBazelRemoteExecutionV2Action": { @@ -1131,7 +1131,8 @@ "DOCKER_CREATE_COMPUTE_SYSTEM_INCORRECT_PARAMETER_ERROR", "DOCKER_TOO_MANY_SYMBOLIC_LINK_LEVELS", "LOCAL_CONTAINER_MANAGER_NOT_RUNNING", - "DOCKER_IMAGE_VPCSC_PERMISSION_DENIED" + "DOCKER_IMAGE_VPCSC_PERMISSION_DENIED", + "WORKING_DIR_NOT_RELATIVE" ], "enumDescriptions": [ "The command succeeded.", @@ -1174,7 +1175,8 @@ "Docker failed to run containers with CreateComputeSystem error that involves an incorrect parameter (more specific version of DOCKER_CREATE_COMPUTE_SYSTEM_ERROR that is user-caused).", "Docker failed to create an overlay mount because of too many levels of symbolic links.", "The local Container Manager is not running.", - "Docker failed because a request was denied by the organization's policy." + "Docker failed because a request was denied by the organization's policy.", + "Working directory is not relative" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/remotebuildexecution.v1alpha.json b/googleapiclient/discovery_cache/documents/remotebuildexecution.v1alpha.json index 5722c64a60c..8742917a3f6 100644 --- a/googleapiclient/discovery_cache/documents/remotebuildexecution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/remotebuildexecution.v1alpha.json @@ -432,7 +432,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://admin-remotebuildexecution.googleapis.com/", "schemas": { "BuildBazelRemoteExecutionV2Action": { @@ -1245,7 +1245,8 @@ "DOCKER_CREATE_COMPUTE_SYSTEM_INCORRECT_PARAMETER_ERROR", "DOCKER_TOO_MANY_SYMBOLIC_LINK_LEVELS", "LOCAL_CONTAINER_MANAGER_NOT_RUNNING", - "DOCKER_IMAGE_VPCSC_PERMISSION_DENIED" + "DOCKER_IMAGE_VPCSC_PERMISSION_DENIED", + "WORKING_DIR_NOT_RELATIVE" ], "enumDescriptions": [ "The command succeeded.", @@ -1288,7 +1289,8 @@ "Docker failed to run containers with CreateComputeSystem error that involves an incorrect parameter (more specific version of DOCKER_CREATE_COMPUTE_SYSTEM_ERROR that is user-caused).", "Docker failed to create an overlay mount because of too many levels of symbolic links.", "The local Container Manager is not running.", - "Docker failed because a request was denied by the organization's policy." + "Docker failed because a request was denied by the organization's policy.", + "Working directory is not relative" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/remotebuildexecution.v2.json b/googleapiclient/discovery_cache/documents/remotebuildexecution.v2.json index 983cc1c9dd3..0dbe49312ad 100644 --- a/googleapiclient/discovery_cache/documents/remotebuildexecution.v2.json +++ b/googleapiclient/discovery_cache/documents/remotebuildexecution.v2.json @@ -447,7 +447,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://remotebuildexecution.googleapis.com/", "schemas": { "BuildBazelRemoteExecutionV2Action": { @@ -1681,7 +1681,8 @@ "DOCKER_CREATE_COMPUTE_SYSTEM_INCORRECT_PARAMETER_ERROR", "DOCKER_TOO_MANY_SYMBOLIC_LINK_LEVELS", "LOCAL_CONTAINER_MANAGER_NOT_RUNNING", - "DOCKER_IMAGE_VPCSC_PERMISSION_DENIED" + "DOCKER_IMAGE_VPCSC_PERMISSION_DENIED", + "WORKING_DIR_NOT_RELATIVE" ], "enumDescriptions": [ "The command succeeded.", @@ -1724,7 +1725,8 @@ "Docker failed to run containers with CreateComputeSystem error that involves an incorrect parameter (more specific version of DOCKER_CREATE_COMPUTE_SYSTEM_ERROR that is user-caused).", "Docker failed to create an overlay mount because of too many levels of symbolic links.", "The local Container Manager is not running.", - "Docker failed because a request was denied by the organization's policy." + "Docker failed because a request was denied by the organization's policy.", + "Working directory is not relative" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index 8da2df2c320..30ef0ada3c2 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -631,7 +631,7 @@ } } }, - "revision": "20210404", + "revision": "20210423", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index bef5e5859b6..9a210a70f89 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -706,7 +706,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -876,7 +876,7 @@ "type": "string" }, "projectId": { - "description": "The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request.", + "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -932,11 +932,11 @@ "id": "GoogleCloudRetailV2GcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", "type": "string" }, "inputUris": { - "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", + "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", "items": { "type": "string" }, @@ -1109,7 +1109,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.", + "description": "The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters, and cannot be empty. Values can be empty, and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object" }, "pageSize": { @@ -1559,7 +1559,7 @@ "description": "User information." }, "visitorId": { - "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 6fa035661c3..3a98deb8879 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -706,7 +706,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1007,7 +1007,7 @@ "type": "string" }, "projectId": { - "description": "The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request.", + "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -1127,11 +1127,11 @@ "id": "GoogleCloudRetailV2alphaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", "type": "string" }, "inputUris": { - "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", + "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", "items": { "type": "string" }, @@ -1304,7 +1304,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.", + "description": "The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters, and cannot be empty. Values can be empty, and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object" }, "pageSize": { @@ -1754,7 +1754,7 @@ "description": "User information." }, "visitorId": { - "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index d90e460d6a4..ae05436549f 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -706,7 +706,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1202,7 +1202,7 @@ "type": "string" }, "projectId": { - "description": "The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request.", + "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -1322,11 +1322,11 @@ "id": "GoogleCloudRetailV2betaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", "type": "string" }, "inputUris": { - "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", + "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", "items": { "type": "string" }, @@ -1499,7 +1499,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.", + "description": "The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters, and cannot be empty. Values can be empty, and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object" }, "pageSize": { @@ -1949,7 +1949,7 @@ "description": "User information." }, "visitorId": { - "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analystics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 9bfe8cc66b0..83dfeed541c 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -899,7 +899,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -1736,7 +1736,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { diff --git a/googleapiclient/discovery_cache/documents/run.v1alpha1.json b/googleapiclient/discovery_cache/documents/run.v1alpha1.json index eb20709c0c9..c4094503533 100644 --- a/googleapiclient/discovery_cache/documents/run.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/run.v1alpha1.json @@ -268,7 +268,7 @@ } } }, - "revision": "20210402", + "revision": "20210416", "rootUrl": "https://run.googleapis.com/", "schemas": { "Capabilities": { diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json index 374e893641d..118d3df0df5 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json @@ -210,7 +210,7 @@ } } }, - "revision": "20210405", + "revision": "20210426", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json index 8d53ed12685..82288600b4a 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json @@ -805,7 +805,7 @@ } } }, - "revision": "20210405", + "revision": "20210426", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json index a5df29388cb..e6267cc5887 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "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 6100eacd34e..bb94ea5eed4 100644 --- a/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json @@ -2483,7 +2483,7 @@ } } }, - "revision": "20210410", + "revision": "20210419", "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 430d7dfcefe..3c78ff4b0b0 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -887,7 +887,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "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 55f82bd1081..b41b805678e 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -373,7 +373,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "ApiDataRow": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index 3506efafe7e..3fc8b8d5df3 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -452,7 +452,7 @@ "versions": { "methods": { "access": { - "description": "Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.", + "description": "Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", "flatPath": "v1/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:access", "httpMethod": "GET", "id": "secretmanager.projects.secrets.versions.access", @@ -461,7 +461,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`.", + "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", "location": "path", "pattern": "^projects/[^/]+/secrets/[^/]+/versions/[^/]+$", "required": true, @@ -561,7 +561,7 @@ ] }, "get": { - "description": "Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.", + "description": "Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", "flatPath": "v1/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}", "httpMethod": "GET", "id": "secretmanager.projects.secrets.versions.get", @@ -570,7 +570,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.", + "description": "Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.", "location": "path", "pattern": "^projects/[^/]+/secrets/[^/]+/versions/[^/]+$", "required": true, @@ -628,7 +628,7 @@ } } }, - "revision": "20210409", + "revision": "20210416", "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 10bd12aef5f..394022b350e 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -628,7 +628,7 @@ } } }, - "revision": "20210409", + "revision": "20210416", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 8b0ecbadc9b..50acf2a9d24 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -1816,7 +1816,7 @@ } } }, - "revision": "20210406", + "revision": "20210422", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Asset": { @@ -2873,7 +2873,7 @@ "type": "object" }, "Resource": { - "description": "Information related to the Google Cloud resource that is associated with this finding. LINT.IfChange", + "description": "Information related to the Google Cloud resource that is associated with this finding.", "id": "Resource", "properties": { "folders": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index b663f0e8d05..ca9877aafa5 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,7 +896,7 @@ } } }, - "revision": "20210406", + "revision": "20210422", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Asset": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 4cf5a980b7c..cb13f1520aa 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -1328,7 +1328,7 @@ } } }, - "revision": "20210406", + "revision": "20210422", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Config": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 40bc191eeac..e4511c083b0 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -696,7 +696,7 @@ "type": "object" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", + "description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read", "id": "Authentication", "properties": { "providers": { @@ -1063,6 +1063,13 @@ "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { + "aliases": { + "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", + "items": { + "type": "string" + }, + "type": "array" + }, "allowCors": { "description": "Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index da8fcecb7ef..01cef3407e4 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -500,7 +500,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -605,7 +605,7 @@ "type": "object" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", + "description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read", "id": "Authentication", "properties": { "providers": { @@ -933,6 +933,13 @@ "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { + "aliases": { + "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", + "items": { + "type": "string" + }, + "type": "array" + }, "allowCors": { "description": "Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index ff3cd95e9d6..21a8f4642a4 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20210401", + "revision": "20210416", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -1436,7 +1436,7 @@ "Decreases available quota by the cost specified for the operation. If cost is higher than available quota, operation fails and returns error.", "Decreases available quota by the cost specified for the operation. If cost is higher than available quota, operation does not fail and available quota goes down to zero but it returns error.", "Does not change any available quota. Only checks if there is enough quota. No lock is placed on the checked tokens neither.", - "Increases available quota by the operation cost specified for the operation." + "DEPRECATED: Increases available quota by the operation cost specified for the operation." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index 2a344d09e56..02bee4cde76 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -169,7 +169,7 @@ } } }, - "revision": "20210401", + "revision": "20210416", "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 2706e4f9243..43d3bec9f32 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -883,7 +883,7 @@ } } }, - "revision": "20210407", + "revision": "20210414", "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 9ca7cf09a8b..ada917a373b 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -883,7 +883,7 @@ } } }, - "revision": "20210407", + "revision": "20210414", "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 7126a195c55..0861a536c6c 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -351,7 +351,7 @@ ] }, "list": { - "description": "Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has \"servicemanagement.services.get\" permission for. **BETA:** If the caller specifies the `consumer_id`, it returns only the services enabled on the consumer. The `consumer_id` must have the format of \"project:{PROJECT-ID}\".", + "description": "Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has \"servicemanagement.services.get\" permission for.", "flatPath": "v1/services", "httpMethod": "GET", "id": "servicemanagement.services.list", @@ -829,7 +829,7 @@ } } }, - "revision": "20210409", + "revision": "20210423", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -993,7 +993,7 @@ "type": "object" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", + "description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read", "id": "Authentication", "properties": { "providers": { @@ -1497,6 +1497,13 @@ "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { + "aliases": { + "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", + "items": { + "type": "string" + }, + "type": "array" + }, "allowCors": { "description": "Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 623e154e5f3..3977e380be2 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -860,7 +860,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1125,7 +1125,7 @@ "type": "object" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", + "description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read", "id": "Authentication", "properties": { "providers": { @@ -1649,6 +1649,13 @@ "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { + "aliases": { + "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", + "items": { + "type": "string" + }, + "type": "array" + }, "allowCors": { "description": "Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index d178976fbad..95cca7527b6 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -502,7 +502,7 @@ "type": "object" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", + "description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read", "id": "Authentication", "properties": { "providers": { @@ -969,6 +969,13 @@ "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { + "aliases": { + "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", + "items": { + "type": "string" + }, + "type": "array" + }, "allowCors": { "description": "Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 003e0eed4a6..3b07fc9bff7 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -434,14 +434,14 @@ "id": "AdminQuotaPolicy", "properties": { "container": { - "description": "The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}", + "description": "The cloud resource container at which the quota policy is created. The format is `{container_type}/{container_number}`", "type": "string" }, "dimensions": { "additionalProperties": { "type": "string" }, - "description": " If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit 1/{project}/{region} could contain an entry with the key \"region\" and the value \"us-east-1\"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If \"region\" appears as a key, its value must be a valid Cloud region. * If \"zone\" appears as a key, its value must be a valid Cloud zone. * Keys other than \"region\" or \"zone\" are not valid.", + "description": " If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.", "type": "object" }, "metric": { @@ -566,7 +566,7 @@ "type": "object" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", + "description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read", "id": "Authentication", "properties": { "providers": { @@ -1057,6 +1057,13 @@ "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { + "aliases": { + "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", + "items": { + "type": "string" + }, + "type": "array" + }, "allowCors": { "description": "Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.", "type": "boolean" @@ -2331,14 +2338,14 @@ "id": "QuotaOverride", "properties": { "adminOverrideAncestor": { - "description": "The resource name of the ancestor that requested the override. For example: \"organizations/12345\" or \"folders/67890\". Used by admin overrides only.", + "description": "The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.", "type": "string" }, "dimensions": { "additionalProperties": { "type": "string" }, - "description": "If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key \"region\" and the value \"us-east-1\"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * \"project\" is not a valid key; the project is already specified in the parent resource name. * \"user\" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If \"region\" appears as a key, its value must be a valid Cloud region. * If \"zone\" appears as a key, its value must be a valid Cloud zone. * If any valid key other than \"region\" or \"zone\" appears in the map, then all valid keys other than \"region\" or \"zone\" must also appear in the map.", + "description": "If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map.", "type": "object" }, "metric": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 79ec66a5e78..e823b005e80 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -182,7 +182,7 @@ "services": { "methods": { "batchEnable": { - "description": "Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation", + "description": "Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation response type: `google.protobuf.Empty`", "flatPath": "v1beta1/{v1beta1Id}/{v1beta1Id1}/services:batchEnable", "httpMethod": "POST", "id": "serviceusage.services.batchEnable", @@ -211,7 +211,7 @@ ] }, "disable": { - "description": "Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation", + "description": "Disables a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation response type: `google.protobuf.Empty`", "flatPath": "v1beta1/{v1beta1Id}/{v1beta1Id1}/services/{servicesId}:disable", "httpMethod": "POST", "id": "serviceusage.services.disable", @@ -240,7 +240,7 @@ ] }, "enable": { - "description": "Enable a service so that it can be used with a project. Operation", + "description": "Enables a service so that it can be used with a project. Operation response type: `google.protobuf.Empty`", "flatPath": "v1beta1/{v1beta1Id}/{v1beta1Id1}/services/{servicesId}:enable", "httpMethod": "POST", "id": "serviceusage.services.enable", @@ -269,7 +269,7 @@ ] }, "generateServiceIdentity": { - "description": "Generate service identity for service.", + "description": "Generates service identity for service.", "flatPath": "v1beta1/{v1beta1Id}/{v1beta1Id1}/services/{servicesId}:generateServiceIdentity", "httpMethod": "POST", "id": "serviceusage.services.generateServiceIdentity", @@ -321,7 +321,7 @@ ] }, "list": { - "description": "List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.", + "description": "Lists all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.", "flatPath": "v1beta1/{v1beta1Id}/{v1beta1Id1}/services", "httpMethod": "GET", "id": "serviceusage.services.list", @@ -376,7 +376,7 @@ ], "parameters": { "name": { - "description": "The resource name of the quota limit. An example name would be: projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests", + "description": "The resource name of the quota limit. An example name would be: `projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests`", "location": "path", "pattern": "^[^/]+/[^/]+/services/[^/]+/consumerQuotaMetrics/[^/]+$", "required": true, @@ -408,7 +408,7 @@ ] }, "importAdminOverrides": { - "description": "Create or update multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.", + "description": "Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.", "flatPath": "v1beta1/{v1beta1Id}/{v1beta1Id1}/services/{servicesId}/consumerQuotaMetrics:importAdminOverrides", "httpMethod": "POST", "id": "serviceusage.services.consumerQuotaMetrics.importAdminOverrides", @@ -437,7 +437,7 @@ ] }, "importConsumerOverrides": { - "description": "Create or update multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.", + "description": "Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.", "flatPath": "v1beta1/{v1beta1Id}/{v1beta1Id1}/services/{servicesId}/consumerQuotaMetrics:importConsumerOverrides", "httpMethod": "POST", "id": "serviceusage.services.consumerQuotaMetrics.importConsumerOverrides", @@ -486,7 +486,7 @@ "type": "string" }, "parent": { - "description": "Parent of the quotas resource. Some example names would be: projects/123/services/serviceconsumermanagement.googleapis.com folders/345/services/serviceconsumermanagement.googleapis.com organizations/456/services/serviceconsumermanagement.googleapis.com", + "description": "Parent of the quotas resource. Some example names would be: `projects/123/services/serviceconsumermanagement.googleapis.com` `folders/345/services/serviceconsumermanagement.googleapis.com` `organizations/456/services/serviceconsumermanagement.googleapis.com`", "location": "path", "pattern": "^[^/]+/[^/]+/services/[^/]+$", "required": true, @@ -959,7 +959,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -967,14 +967,14 @@ "id": "AdminQuotaPolicy", "properties": { "container": { - "description": "The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}", + "description": "The cloud resource container at which the quota policy is created. The format is `{container_type}/{container_number}`", "type": "string" }, "dimensions": { "additionalProperties": { "type": "string" }, - "description": " If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit 1/{project}/{region} could contain an entry with the key \"region\" and the value \"us-east-1\"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If \"region\" appears as a key, its value must be a valid Cloud region. * If \"zone\" appears as a key, its value must be a valid Cloud zone. * Keys other than \"region\" or \"zone\" are not valid.", + "description": " If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.", "type": "object" }, "metric": { @@ -1099,7 +1099,7 @@ "type": "object" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", + "description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read", "id": "Authentication", "properties": { "providers": { @@ -1362,7 +1362,7 @@ "type": "array" }, "displayName": { - "description": "The display name of the metric. An example name would be: \"CPUs\"", + "description": "The display name of the metric. An example name would be: `CPUs`", "type": "string" }, "metric": { @@ -1370,7 +1370,7 @@ "type": "string" }, "name": { - "description": "The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.", + "description": "The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.", "type": "string" }, "unit": { @@ -1622,6 +1622,13 @@ "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { + "aliases": { + "description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.", + "items": { + "type": "string" + }, + "type": "array" + }, "allowCors": { "description": "Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.", "type": "boolean" @@ -2990,7 +2997,7 @@ "additionalProperties": { "type": "string" }, - "description": "The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key \"region\" and value \"us-east-1\", then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.", + "description": "The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.", "type": "object" }, "effectiveLimit": { @@ -3064,14 +3071,14 @@ "id": "QuotaOverride", "properties": { "adminOverrideAncestor": { - "description": "The resource name of the ancestor that requested the override. For example: \"organizations/12345\" or \"folders/67890\". Used by admin overrides only.", + "description": "The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.", "type": "string" }, "dimensions": { "additionalProperties": { "type": "string" }, - "description": "If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key \"region\" and the value \"us-east-1\"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * \"project\" is not a valid key; the project is already specified in the parent resource name. * \"user\" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If \"region\" appears as a key, its value must be a valid Cloud region. * If \"zone\" appears as a key, its value must be a valid Cloud zone. * If any valid key other than \"region\" or \"zone\" appears in the map, then all valid keys other than \"region\" or \"zone\" must also appear in the map.", + "description": "If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map.", "type": "object" }, "metric": { @@ -3103,11 +3110,11 @@ "description": "The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method." }, "name": { - "description": "The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com", + "description": "The resource name of the consumer and service. A valid name would be: - `projects/123/services/serviceusage.googleapis.com`", "type": "string" }, "parent": { - "description": "The resource name of the consumer. A valid name would be: - projects/123", + "description": "The resource name of the consumer. A valid name would be: - `projects/123`", "type": "string" }, "state": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index f359efadca1..972103689fc 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20210329", + "revision": "20210420", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { diff --git a/googleapiclient/discovery_cache/documents/slides.v1.json b/googleapiclient/discovery_cache/documents/slides.v1.json index cd3bdf8dc0c..e163830af1a 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -313,7 +313,7 @@ } } }, - "revision": "20210329", + "revision": "20210420", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json index 0eefd836746..f2e552bf00e 100644 --- a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json @@ -345,7 +345,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index a7a76cfeac5..429d67f917a 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -1923,7 +1923,7 @@ } } }, - "revision": "20210325", + "revision": "20210405", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Backup": { @@ -3376,11 +3376,11 @@ "type": "string" }, "requestTag": { - "description": "A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). `request_tag` must be a valid identifier of the form: `a-zA-Z` between 2 and 64 characters in length", + "description": "A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated.", "type": "string" }, "transactionTag": { - "description": "A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn\u2019t belong to any transaction, transaction_tag will be ignored. `transaction_tag` must be a valid identifier of the format: `a-zA-Z{0,49}`", + "description": "A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn\u2019t belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index 3b804df5f1c..1340c67260e 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -212,7 +212,7 @@ } } }, - "revision": "20210401", + "revision": "20210407", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ListOperationsResponse": { @@ -403,7 +403,7 @@ "description": "Metadata regarding this request." }, "model": { - "description": "Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. ", + "description": "Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. ", "type": "string" }, "profanityFilter": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index 1958010b991..a9c6a7a3666 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20210401", + "revision": "20210407", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { @@ -910,7 +910,7 @@ "description": "Metadata regarding this request." }, "model": { - "description": "Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. ", + "description": "Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. *Model* *Description* command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. ", "type": "string" }, "profanityFilter": { diff --git a/googleapiclient/discovery_cache/documents/speech.v2beta1.json b/googleapiclient/discovery_cache/documents/speech.v2beta1.json index 760a3f801b0..3034616e5e7 100644 --- a/googleapiclient/discovery_cache/documents/speech.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v2beta1.json @@ -184,7 +184,7 @@ } } }, - "revision": "20210401", + "revision": "20210407", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ListOperationsResponse": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index d17d4f23e63..7ee61061132 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -1834,7 +1834,7 @@ } } }, - "revision": "20210406", + "revision": "20210420", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2365,6 +2365,10 @@ "$ref": "OnPremisesConfiguration", "description": "Configuration specific to on-premises instances." }, + "outOfDiskReport": { + "$ref": "SqlOutOfDiskReport", + "description": "This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job" + }, "project": { "description": "The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.", "type": "string" @@ -3869,6 +3873,32 @@ }, "type": "object" }, + "SqlOutOfDiskReport": { + "description": "This message wraps up the information written by out-of-disk detection job.", + "id": "SqlOutOfDiskReport", + "properties": { + "sqlMinRecommendedIncreaseSizeGb": { + "description": "The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend", + "format": "int32", + "type": "integer" + }, + "sqlOutOfDiskState": { + "description": "This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job", + "enum": [ + "SQL_OUT_OF_DISK_STATE_UNSPECIFIED", + "NORMAL", + "SOFT_SHUTDOWN" + ], + "enumDescriptions": [ + "Unspecified state", + "The instance has plenty space on data disk", + "Data disk is almost used up. It is shutdown to prevent data corruption." + ], + "type": "string" + } + }, + "type": "object" + }, "SqlScheduledMaintenance": { "description": "Any scheduled maintenancce for this instance.", "id": "SqlScheduledMaintenance", diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 2d76651d9e2..6050a53d6c7 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": "\"34343035353832383335383231393837323231\"", + "etag": "\"37343732323130313734323537383335363533\"", "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" @@ -3230,7 +3230,7 @@ } } }, - "revision": "20210407", + "revision": "20210422", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { diff --git a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json index 795e69aed89..f6abb92abeb 100644 --- a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json @@ -434,7 +434,7 @@ } } }, - "revision": "20210325", + "revision": "20210415", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AwsAccessKey": { @@ -593,7 +593,7 @@ "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", @@ -1034,7 +1034,7 @@ "type": "string" }, "name": { - "description": "A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `\"transferJobs/\"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `\"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$\"` Invalid job names will fail with an INVALID_ARGUMENT error.", + "description": "A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `\"transferJobs/\"` prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `\"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$\"` Invalid job names will fail with an INVALID_ARGUMENT error.", "type": "string" }, "notificationConfig": { diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index 72c0db882cf..64a59727f05 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -375,7 +375,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { @@ -466,7 +466,7 @@ "type": "object" }, "LatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "LatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index 6aa06efc15a..312f04aa3f8 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIdentityStsV1ExchangeTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1beta.json b/googleapiclient/discovery_cache/documents/sts.v1beta.json index a4a15e494f8..bc922087739 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -116,7 +116,7 @@ } } }, - "revision": "20210403", + "revision": "20210417", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIdentityStsV1betaExchangeTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index 1879268af80..f3761c542a7 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20210407", + "revision": "20210424", "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 5cd5f60293e..0cfe72dee65 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3125,7 +3125,7 @@ } } }, - "revision": "20210407", + "revision": "20210424", "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 ef56b75314d..decdd159b72 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "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 38623a5ff38..af11c2dbf2d 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -282,7 +282,7 @@ } } }, - "revision": "20210402", + "revision": "20210423", "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 66960325838..fa299ccc365 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20210326", + "revision": "20210416", "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 18fbdec2b43..d083db5fe7b 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20210326", + "revision": "20210416", "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 7bd693d028b..c4acdf2e74d 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, - "revision": "20210412", + "revision": "20210427", "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 bc9dfd690ac..b43252c3b34 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -659,7 +659,7 @@ } } }, - "revision": "20210401", + "revision": "20210423", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json index db0344ae6f2..5d0abbe8fa1 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -659,7 +659,7 @@ } } }, - "revision": "20210401", + "revision": "20210419", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json index 8655dc1038b..fc8b5a53da1 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20210401", + "revision": "20210414", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/transcoder.v1beta1.json b/googleapiclient/discovery_cache/documents/transcoder.v1beta1.json index 896f83a17c2..d90516d0178 100644 --- a/googleapiclient/discovery_cache/documents/transcoder.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/transcoder.v1beta1.json @@ -355,7 +355,7 @@ } } }, - "revision": "20210406", + "revision": "20210415", "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 77399a4820e..d880fa94b96 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3.json +++ b/googleapiclient/discovery_cache/documents/translate.v3.json @@ -687,7 +687,7 @@ } } }, - "revision": "20210412", + "revision": "20210416", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchTranslateTextRequest": { diff --git a/googleapiclient/discovery_cache/documents/translate.v3beta1.json b/googleapiclient/discovery_cache/documents/translate.v3beta1.json index 7e855714160..b8d4d0a61bb 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/translate.v3beta1.json @@ -687,7 +687,7 @@ } } }, - "revision": "20210412", + "revision": "20210416", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchTranslateTextRequest": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index 294c94e556e..c8a0f8bb560 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -15,7 +15,7 @@ "baseUrl": "https://vault.googleapis.com/", "batchPath": "batch", "canonicalName": "Vault", - "description": "Archiving and eDiscovery for G Suite.", + "description": "Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. ", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/vault", "fullyEncodeReservedExpansion": true, @@ -1193,7 +1193,7 @@ } } }, - "revision": "20210406", + "revision": "20210419", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/googleapiclient/discovery_cache/documents/vectortile.v1.json b/googleapiclient/discovery_cache/documents/vectortile.v1.json index 94aaf69c838..abf7281b92f 100644 --- a/googleapiclient/discovery_cache/documents/vectortile.v1.json +++ b/googleapiclient/discovery_cache/documents/vectortile.v1.json @@ -343,7 +343,7 @@ } } }, - "revision": "20210410", + "revision": "20210427", "rootUrl": "https://vectortile.googleapis.com/", "schemas": { "Area": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1.json b/googleapiclient/discovery_cache/documents/vision.v1.json index 6db81266e33..e94cbd23b3d 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1.json @@ -1282,7 +1282,7 @@ } } }, - "revision": "20210407", + "revision": "20210423", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { @@ -8382,7 +8382,7 @@ "type": "object" }, "LatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "LatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json index 879884508cd..cf877562ae1 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20210407", + "revision": "20210423", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { @@ -7570,7 +7570,7 @@ "type": "object" }, "LatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "LatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json index 581ba69a026..1452c662ab1 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20210407", + "revision": "20210423", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { @@ -7570,7 +7570,7 @@ "type": "object" }, "LatLng": { - "description": "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 must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "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.", "id": "LatLng", "properties": { "latitude": { diff --git a/googleapiclient/discovery_cache/documents/webfonts.v1.json b/googleapiclient/discovery_cache/documents/webfonts.v1.json index 75df5637377..f268f970050 100644 --- a/googleapiclient/discovery_cache/documents/webfonts.v1.json +++ b/googleapiclient/discovery_cache/documents/webfonts.v1.json @@ -134,7 +134,7 @@ } } }, - "revision": "20210410", + "revision": "20210424", "rootUrl": "https://webfonts.googleapis.com/", "schemas": { "Webfont": { diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index 6ba6c91a3ac..382e797629f 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -446,7 +446,7 @@ } } }, - "revision": "20210403", + "revision": "20210424", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json index 0e87f94baa4..30989553ca6 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json @@ -526,7 +526,7 @@ } } }, - "revision": "20210408", + "revision": "20210424", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { @@ -909,6 +909,10 @@ ], "type": "string" }, + "ignoreHttpStatusErrors": { + "description": "Whether to keep scanning even if most requests return HTTP error codes.", + "type": "boolean" + }, "managedScan": { "description": "Whether the scan config is managed by Web Security Scanner, output only.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json index d45c271e5ad..77730d153c6 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json @@ -526,7 +526,7 @@ } } }, - "revision": "20210408", + "revision": "20210424", "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 d3c156894d8..d130fcf3e45 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json @@ -526,7 +526,7 @@ } } }, - "revision": "20210408", + "revision": "20210424", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { @@ -908,6 +908,10 @@ ], "type": "string" }, + "ignoreHttpStatusErrors": { + "description": "Whether to keep scanning even if most requests return HTTP error codes.", + "type": "boolean" + }, "latestRun": { "$ref": "ScanRun", "description": "Latest ScanRun if available." diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index 628de96520c..9ffd4d613ab 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -269,7 +269,7 @@ } } }, - "revision": "20210316", + "revision": "20210415", "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 afebd6b6b12..6971e2f2c36 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json @@ -269,7 +269,7 @@ } } }, - "revision": "20210316", + "revision": "20210415", "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 89f532cb6af..307542e03ef 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -156,7 +156,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service will select a default.", + "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" @@ -444,7 +444,7 @@ } } }, - "revision": "20210401", + "revision": "20210415", "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 9f9be51c71d..4a6c46daceb 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json @@ -12,7 +12,7 @@ "baseUrl": "https://workflows.googleapis.com/", "batchPath": "batch", "canonicalName": "Workflows", - "description": "Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.", + "description": "Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/workflows", "fullyEncodeReservedExpansion": true, @@ -444,7 +444,7 @@ } } }, - "revision": "20210408", + "revision": "20210422", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 26862e6833b..304dd24d435 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -3764,7 +3764,7 @@ } } }, - "revision": "20210410", + "revision": "20210423", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { diff --git a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json index befdf75dfb0..1430d8e59ca 100644 --- a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +++ b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json @@ -421,7 +421,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "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 f0efbdb0b93..7fd4b7de0ef 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20210410", + "revision": "20210426", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { diff --git a/noxfile.py b/noxfile.py index cbcfbb691e2..0fda3e1ffe4 100644 --- a/noxfile.py +++ b/noxfile.py @@ -13,9 +13,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +import os import sys import nox +import os +import shutil test_dependencies = [ "django>=2.0.0", @@ -58,9 +61,22 @@ def lint(session): ], ) def unit(session, oauth2client): + # Clean up dist and build folders + shutil.rmtree('dist', ignore_errors=True) + shutil.rmtree('build', ignore_errors=True) + session.install(*test_dependencies) session.install(oauth2client) - session.install('.') + + # Create and install wheels + session.run('python3', 'setup.py', 'bdist_wheel') + session.install(os.path.join('dist', os.listdir('dist').pop())) + + # Run tests from a different directory to test the package artifacts + root_dir = os.path.dirname(os.path.realpath(__file__)) + temp_dir = session.create_tmp() + session.chdir(temp_dir) + shutil.copytree(os.path.join(root_dir, 'tests'), 'tests') # Run py.test against the unit tests. session.run( @@ -75,3 +91,21 @@ def unit(session, oauth2client): "tests", *session.posargs, ) + +@nox.session(python=["3.9"]) +def scripts(session): + session.install(*test_dependencies) + session.install("-e", ".") + session.install("-r", "scripts/requirements.txt") + + # Run py.test against the unit tests. + session.run( + "py.test", + "--quiet", + "--cov=scripts", + "--cov-config=.coveragerc", + "--cov-report=", + "--cov-fail-under=80", + "scripts", + *session.posargs, + ) diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 00000000000..f2b59bd7a6b --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,21 @@ +# Discovery Artifact Automation +Discovery Artifacts are automatically updated using a Github Action script. This +documentation is intended for users that need to maintain the repository. + +## Updating discovery artifacts locally + +To update discovery artifacts locally: +1. Create a virtual environment using `pyenv virtualenv updateartifacts` +2. Activate the virtual environment using `pyenv activate updateartifacts` +3. Clone the repository, and `cd` into the `scripts` directory +4. Run `pip install -r requirements.txt` +5. Run `pip install -e ../` +6. Run `git checkout -b update-discovery-artifacts-manual` +7. Run `python3 updatediscoveryartifacts.py` +8. Run `./createcommits.sh` +9. Run `python3 buildprbody.py` +10. Create a pull request with the changes. +11. Copy the contents of `temp/allapis.summary` into the PR Body. + +## Questions +Feel free to submit an issue! diff --git a/scripts/buildprbody.py b/scripts/buildprbody.py new file mode 100644 index 00000000000..10733b4750a --- /dev/null +++ b/scripts/buildprbody.py @@ -0,0 +1,104 @@ +# Copyright 2021 Google LLC + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# https://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from enum import IntEnum +import numpy as np +import pandas as pd +import pathlib + +class ChangeType(IntEnum): + UNKNOWN = 0 + DELETED = 1 + ADDED = 2 + CHANGED = 3 + + +def get_commit_link(name): + """Return a string with a link to the last commit for the given + API Name. + args: + name (str): The name of the api. + """ + + url = "https://github.com/googleapis/google-api-python-client/commit/" + sha = None + api_link = "" + + file_path = pathlib.Path(directory).joinpath("{0}.sha".format(name)) + if file_path.is_file(): + with open(file_path, "r") as f: + sha = f.readline().rstrip() + if sha: + api_link = "[{0}]({1}{2})".format(" [More details]", url, sha) + + return api_link + + +if __name__ == "__main__": + directory = pathlib.Path("temp") + dataframe = pd.read_csv("temp/allapis.dataframe") + dataframe["Version"] = dataframe["Version"].astype(str) + + dataframe["Commit"] = np.vectorize(get_commit_link)(dataframe["Name"]) + + stable_and_breaking = ( + dataframe[ + dataframe["IsStable"] + & (dataframe["ChangeType"] == ChangeType.DELETED) + ][["Name", "Version", "Commit"]] + .drop_duplicates() + .agg("".join, axis=1) + .values + ) + + prestable_and_breaking = ( + dataframe[ + (dataframe["IsStable"] == False) + & (dataframe["ChangeType"] == ChangeType.DELETED) + ][["Name", "Version", "Commit"]] + .drop_duplicates() + .agg("".join, axis=1) + .values + ) + + all_apis = ( + dataframe[["Name", "Version", "Commit"]] + .drop_duplicates() + .agg("".join, axis=1) + .values + ) + + with open(directory / "allapis.summary", "w") as f: + if len(stable_and_breaking) > 0: + f.writelines( + [ + "## Deleted keys were detected in the following stable discovery artifacts:\n", + "\n".join(stable_and_breaking), + "\n\n", + ] + ) + + if len(prestable_and_breaking) > 0: + f.writelines( + [ + "## Deleted keys were detected in the following pre-stable discovery artifacts:\n", + "\n".join(prestable_and_breaking), + "\n\n", + ] + ) + + if len(all_apis) > 0: + f.writelines( + ["## Discovery Artifact Change Summary:\n", "\n".join(all_apis), "\n"] + ) diff --git a/scripts/changesummary.py b/scripts/changesummary.py new file mode 100644 index 00000000000..badb7b8b123 --- /dev/null +++ b/scripts/changesummary.py @@ -0,0 +1,524 @@ +# Copyright 2021 Google LLC + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# https://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from enum import IntEnum +import json +from multiprocessing import Pool +import pandas as pd +import pathlib +import numpy as np + +BRANCH_ARTIFACTS_DIR = ( + pathlib.Path(__file__).parent.resolve() / "googleapiclient" / "discovery_cache" / "documents" +) +MAIN_ARTIFACTS_DIR = ( + pathlib.Path(__file__).parent.resolve() / ".." / "main" / "googleapiclient" / "discovery_cache" / "documents" +) + +MULTIPROCESSING_NUM_PER_BATCH = 5 +MULTIPROCESSING_NUM_AGENTS = 10 + + +class ChangeType(IntEnum): + UNKNOWN = 0 + DELETED = 1 + ADDED = 2 + CHANGED = 3 + + +class DirectoryDoesNotExist(ValueError): + """Raised when the specified directory does not exist.""" + + pass + + +class ChangeSummary: + """Represents the change summary between 2 directories containing \ + artifacts. + """ + + def __init__(self, new_artifacts_dir, current_artifacts_dir, temp_dir, file_list): + """Initializes an instance of a ChangeSummary. + + Args: + new_artifacts_dir (str): The relative path to the directory with the + new discovery artifacts. + current_artifacts_dir (str): The relative path to the directory with + the current discovery artifacts. + temp_dir (str): The relative path to the directory used for + temporary storage where intermediate files will be stored. + file_list (list): A list of strings containing files to analyze. + """ + + self._file_list = file_list + self._new_artifacts_dir = pathlib.Path(new_artifacts_dir) + self._current_artifacts_dir = pathlib.Path(current_artifacts_dir) + self._temp_dir = pathlib.Path(temp_dir) + + # Sanity checks to ensure directories exist + self._raise_if_directory_not_found(self._new_artifacts_dir) + self._raise_if_directory_not_found(self._current_artifacts_dir) + self._raise_if_directory_not_found(self._temp_dir) + + def _raise_if_directory_not_found(self, directory): + """Raises if the `directory` doesn't exist + + args: + directory (str): The relative path to the `directory` + """ + + if not pathlib.Path(directory).exists(): + raise DirectoryDoesNotExist( + "Directory does not exist : {0}".format(directory) + ) + + def _load_json_to_dataframe(self, file_path): + """Returns a pandas dataframe from the json file provided. + + args: + file_path (str): The relative path to the discovery artifact to + parse. + """ + + # Create an empty dataframe as we will need to return it if the file + # doesn't exist + dataframe_doc = pd.DataFrame() + + if pathlib.Path(file_path).is_file(): + with open(file_path, "r") as f: + # Now load the json file into a pandas dataframe as a flat table + dataframe_doc = pd.json_normalize(json.load(f)) + return dataframe_doc + + def _get_discovery_differences(self, filename): + """Returns a pandas dataframe which contains the differences with the + current and new discovery artifact directories, corresponding to the + file name provided. + + args: + filename (str): The name of the discovery artifact to parse. + """ + # The paths of the 2 discovery artifacts to compare + current_artifact_path = self._current_artifacts_dir / filename + new_artifact_path = self._new_artifacts_dir / filename + + # Use a helper functions to load the discovery artifacts into pandas + # dataframes + current_doc = self._load_json_to_dataframe(current_artifact_path) + new_doc = self._load_json_to_dataframe(new_artifact_path) + + # Concatenate the 2 dataframes, transpose them, and create + # a new dataframe called combined_docs with columns + # `Key`, `CurrentValue`, `NewValue`. + combined_docs = ( + pd.concat([current_doc, new_doc], keys=["CurrentValue", "NewValue"]) + # Drop the index column + .reset_index(drop=True,level=1) + # Transpose the DataFrame, Resulting Columns should be + # ["Key", "CurrentValue", "New Value"] + .rename_axis(['Key'], axis=1) + .transpose() + # Drop the index column + .reset_index() + ) + + # When discovery documents are added, the column `CurrentValue` will + # not exist. In that case, we'll just populate with `np.nan`. + if "CurrentValue" not in combined_docs.columns: + combined_docs["CurrentValue"] = np.nan + + # When discovery documents are deleted, the column `NewValue` will + # not exist. In that case, we'll just populate with `np.nan`. + if "NewValue" not in combined_docs.columns: + combined_docs["NewValue"] = np.nan + + # Split the Key into 2 columns for `Parent` and `Child` in order + # to group keys with the same parents together to summarize the changes + # by parent. + parent_child_df = combined_docs["Key"].str.rsplit(".", 1, expand=True) + # Rename the columns and join them with the combined_docs dataframe. + # If we only have a `Parent` column, it means that the Key doesn't have + # any children. + if len(parent_child_df.columns) == 1: + parent_child_df.columns = ["Parent"] + else: + parent_child_df.columns = ["Parent", "Child"] + combined_docs = combined_docs.join(parent_child_df) + + # Create a new column `Added` to identify rows which have new keys. + combined_docs["Added"] = np.where( + combined_docs["CurrentValue"].isnull(), True, False + ) + + # Create a new column `Deleted` to identify rows which have deleted keys. + combined_docs["Deleted"] = np.where( + combined_docs["NewValue"].isnull(), True, False + ) + + # Aggregate the keys added by grouping keys with the same parents + # together to summarize the changes by parent rather than by key. + parent_added_agg = ( + combined_docs.groupby("Parent") + .Added.value_counts(normalize=True) + .reset_index(name="Proportion") + ) + + # Add a column NumLevels to inicate the number of levels in the tree + # which will allow us to sort the parents in hierarchical order. + parent_added_agg["NumLevels"] = ( + parent_added_agg["Parent"].str.split(".").apply(lambda x: len(x)) + ) + + # Aggregate the keys deleted by grouping keys with the same parents + # together to summarize the changes by parent rather than by key. + parent_deleted_agg = ( + combined_docs.groupby("Parent") + .Deleted.value_counts(normalize=True) + .reset_index(name="Proportion") + ) + + # Add a column NumLevels to inicate the number of levels in the tree + # which will allow us to sort the parents in hierarchical order. + parent_deleted_agg["NumLevels"] = ( + parent_added_agg["Parent"].str.split(".").apply(lambda x: len(x)) + ) + + # Create a list of all parents that have been added in hierarchical + # order. When `Proportion` is 1, it means that the parent is new as all + # children keys have been added. + all_added = ( + parent_added_agg[ + (parent_added_agg["Proportion"] == 1) & (parent_added_agg["Added"] == True) + ][["Parent", "NumLevels"]] + .sort_values("NumLevels", ascending=True) + .Parent.to_list() + ) + + # Create a list of all parents that have been deleted in hierarchical + # order. When `Proportion` is 1, it means that the parent is new as all + # children keys have been deleted. + all_deleted = ( + parent_deleted_agg[ + (parent_deleted_agg["Proportion"] == 1) + & (parent_deleted_agg["Deleted"] == True) + ][["Parent", "NumLevels"]] + .sort_values("NumLevels", ascending=True) + .Parent.to_list() + ) + + # Go through the list of parents that have been added. If we find any + # keys with parents which are a substring of the parent in this list, + # then it means that the entire parent is new. We don't need verbose + # information about the children, so we replace the parent. + for i in range(0, len(all_added)): + word = all_added[i] + combined_docs.Parent = np.where( + combined_docs["Parent"].str.startswith(word), word, combined_docs.Parent + ) + + # Go through the list of parents that have been deleted. If we find any + # keys with parents which are a substring of the parent in this list, + # then it means that the entire parent is deleted. We don't need verbose + # information about the children, so we replace the parent. + for i in range(0, len(all_deleted)): + word = all_deleted[i] + combined_docs.Parent = np.where( + combined_docs["Parent"].str.startswith(word), word, combined_docs.Parent + ) + + # Create a new dataframe with only the keys which have changed + docs_diff = combined_docs[ + combined_docs["CurrentValue"] != combined_docs["NewValue"] + ].copy(deep=False) + + # Get the API and Version from the file name but exclude the extension. + api_version_string = filename.split(".")[:-1] + # Create columns `Name` and `Version` using the version string + docs_diff["Name"] = api_version_string[0] + docs_diff["Version"] = ".".join(api_version_string[1:]) + + # These conditions are used as arguments in the `np.where` function + # below. + deleted_condition = docs_diff["NewValue"].isnull() + added_condition = docs_diff["CurrentValue"].isnull() + + # Create a new `ChangeType` column. The `np.where()` function is like a + # tenary operator. When the `deleted_condition` is `True`, the + # `ChangeType` will be `ChangeType.Deleted`. If the added_condition is + # `True` the `ChangeType` will be `ChangeType.Added`, otherwise the + # `ChangeType` will be `ChangeType.Changed`. + docs_diff["ChangeType"] = np.where( + deleted_condition, + ChangeType.DELETED, + np.where(added_condition, ChangeType.ADDED, ChangeType.CHANGED), + ) + + # Filter out keys which rarely affect functionality. For example: + # {"description", "documentation", "enum", "etag", "revision", "title", + # "url", "rootUrl"} + docs_diff = docs_diff[ + ~docs_diff["Key"].str.contains( + "|".join(self._get_keys_to_ignore()), case=False + ) + ] + + # Group keys with similar parents together and create a new column + # called 'Count' which indicates the number of keys that have been + # grouped together. The reason for the count column is that when keys + # have the same parent, we group them together to improve readability. + docs_diff = ( + docs_diff.groupby( + ["Parent", "Added", "Deleted", "Name", "Version", "ChangeType"] + ) + .size() + .reset_index(name="Count")[ + ["Parent", "Added", "Deleted", "Name", "Version", "ChangeType", "Count"] + ] + ) + + # Rename the Parent column to the Key Column since we are reporting + # summary information of keys with the same parent. + docs_diff.rename(columns={"Parent": "Key"}, inplace=True) + return docs_diff + + def _build_summary_message(self, api_name, is_feature): + """Returns a string containing the summary for a given api. The string + returned will be in the format `fix(): update the API` + when `is_feature=False` and `feat()!: update the API` + when `is_feature=True`. + + args: + api_name (str): The name of the api to include in the summary. + is_feature (bool): If True, include the prefix `feat` otherwise use + `fix` + """ + + # Build the conventional commit string based on the arguments provided + commit_type = "feat" if is_feature else "fix" + return "{0}({1}): update the api".format(commit_type, api_name) + + def _get_keys_to_ignore(self): + """Returns a list of strings with keys to ignore because they rarely + affect functionality. + + args: None + """ + keys_to_ignore = [ + "description", + "documentation", + "enum", + "etag", + "revision", + "title", + "url", + "rootUrl", + ] + return keys_to_ignore + + def _get_stable_versions(self, versions): + """ Returns a pandas series `pd.Series()` of boolean values, + corresponding to the given series, indicating whether the version is + considered stable or not. + args: + versions (object): a pandas series containing version + information for all discovery artifacts. + """ + # Use a regex on the version to find versions with the pattern + # .<0-9>.<0-9>.<0-9> . Any api that matches this pattern will be + # labeled as stable. In other words, v1, v1.4 and v1.4.5 is stable + # but v1b1 v1aplha and v1beta1 is not stable. + return versions.str.extract(r"(v\d?\.?\d?\.?\d+$)").notnull() + + def _get_summary_and_write_to_disk(self, dataframe, directory): + """Writes summary information to file about changes made to discovery + artifacts based on the provided dataframe and returns a dataframe + with the same. The file `'allapis.summary'` is saved to the current + working directory. + args: + dataframe (object): a pandas dataframe containing summary change + information for all discovery artifacts + directory (str): path where the summary file should be saved + """ + + dataframe["IsStable"] = self._get_stable_versions(dataframe["Version"]) + + # Create a filter for features, which contains only rows which have keys + # that have been deleted or added, that will be used as an argument in + # the `np.where()` call below. + filter_features = (dataframe["ChangeType"] == ChangeType.DELETED) | ( + dataframe["ChangeType"] == ChangeType.ADDED + ) + + # Create a new column `IsFeature` to indicate which rows should be + # considered as features. + dataframe["IsFeature"] = np.where(filter_features, True, np.nan) + + # Create a new column `IsFeatureAggregate` which will be used to + # summarize the api changes. We can either have feature or fix but not + # both. + dataframe["IsFeatureAggregate"] = dataframe.groupby("Name").IsFeature.transform( + lambda x: x.any() + ) + + # Create a new column `Summary`, which will contain a string with the + # conventional commit message. + dataframe["Summary"] = np.vectorize(self._build_summary_message)( + dataframe["Name"], + dataframe["IsFeatureAggregate"] + ) + + # Write the final dataframe to disk as it will be used in the + # buildprbody.py script + dataframe.to_csv(directory / "allapis.dataframe") + return dataframe + + def _write_verbose_changes_to_disk(self, dataframe, directory, summary_df): + """ Writes verbose information to file about changes made to discovery + artifacts based on the provided dataframe. A separate file is saved + for each api in the current working directory. The extension of the + files will be `'.verbose'`. + + args: + dataframe (object): a pandas dataframe containing verbose change + information for all discovery artifacts + directory (str): path where the summary file should be saved + summary_df (object): A dataframe containing a summary of the changes + """ + # Array of strings which will contains verbose change information for + # each api + verbose_changes = [] + + # Sort the dataframe to minimize file operations below. + dataframe.sort_values(by=["Name","Version","ChangeType"], + ascending=True, inplace=True) + + # Select only the relevant columns. We need to create verbose output + # by Api Name, Version and ChangeType so we need to group by these + # columns. + + change_type_groups = dataframe[ + ["Name", "Version", "ChangeType", "Key", "Count"] + ].groupby(["Name", "Version", "ChangeType"]) + + lastApi = "" + lastVersion = "" + lastType = ChangeType.UNKNOWN + + f = None + for name, group in change_type_groups: + currentApi = name[0] + currentVersion = name[1] + currentType = name[2] + + # We need to handing file opening and closing when processing an API + # which is different from the previous one + if lastApi != currentApi: + # If we are processing a new api, close the file used for + # processing the previous API + if f is not None: + f.writelines(verbose_changes) + f.close() + f = None + # Clear the array of strings with information from the previous + # api and reset the last version + verbose_changes = [] + lastVersion = '' + # Create a file which contains verbose changes for the current + # API being processed + filename = "{0}.verbose".format(currentApi) + f = open(pathlib.Path(directory / filename), "a") + lastApi = currentApi + + # Create a filter with only the rows for the current API + current_api_filter = summary_df["Name"] == currentApi + + # Get the string in the `Summary` column for the current api and + # append it to `verbose_changes`. The `Summary` column contains + # the conventional commit message. Use pandas.Series.iloc[0] to + # retrieve only the first elemnt, since all the values in the + # summary column are the same for a given API. + verbose_changes.append(summary_df[current_api_filter].Summary.iloc[0]) + + + # If the version has changed, we need to create append a new heading + # in the verbose summary which contains the api and version. + if lastVersion != currentVersion: + # Append a header string with the API and version + verbose_changes.append("\n\n#### {0}:{1}\n\n".format(currentApi, currentVersion)) + + lastVersion = currentVersion + lastType = ChangeType.UNKNOWN + + # Whenever the change type is different, we need to create a new + # heading for the group of keys with the same change type. + if currentType != lastType: + if currentType == ChangeType.DELETED: + verbose_changes.append("\nThe following keys were deleted:\n") + elif currentType == ChangeType.ADDED: + verbose_changes.append("\nThe following keys were added:\n") + else: + verbose_changes.append("\nThe following keys were changed:\n") + + lastType = currentType + + # Append the keys, and corresponding count, in the same change + # type group. + verbose_changes.extend( + [ + "- {0} (Total Keys: {1})\n".format(row['Key'], row['Count']) + for index, row in group[["Key", "Count"]].iterrows() + ] + ) + + # Make sure to close the last file and write the changes. + if f is not None: + f.writelines(verbose_changes) + f.close() + f = None + + def detect_discovery_changes(self): + """Writes a summary of the changes to the discovery artifacts to disk + at the path specified in `temp_dir`. + + args: None + """ + result = pd.DataFrame() + # Process files in parallel to improve performance + with Pool(processes=MULTIPROCESSING_NUM_AGENTS) as pool: + result = result.append( + pool.map( + self._get_discovery_differences, + self._file_list, + MULTIPROCESSING_NUM_PER_BATCH, + ) + ) + + if len(result): + # Sort the resulting dataframe by `Name`, `Version`, `ChangeType` + # and `Key` + sort_columns = ["Name", "Version", "ChangeType", "Key"] + result.sort_values(by=sort_columns, ascending=True, inplace=True) + + # Create a folder which be used by the `createcommits.sh` and + # `buildprbody.py` scripts. + pathlib.Path(self._temp_dir).mkdir(exist_ok=True) + + # Create a summary which contains a conventional commit message + # for each API and write it to disk. + summary_df = self._get_summary_and_write_to_disk(result, self._temp_dir) + + # Create verbose change information for each API which contains + # a list of changes by key and write it to disk. + self._write_verbose_changes_to_disk(result, self._temp_dir, summary_df) + diff --git a/scripts/changesummary_test.py b/scripts/changesummary_test.py new file mode 100644 index 00000000000..583dbe1ea15 --- /dev/null +++ b/scripts/changesummary_test.py @@ -0,0 +1,240 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""ChangeSummary tests.""" + +__author__ = "partheniou@google.com (Anthonios Partheniou)" + +import pathlib +import shutil +import unittest + +import pandas as pd + +from changesummary import ChangeSummary +from changesummary import ChangeType +from changesummary import DirectoryDoesNotExist + +SCRIPTS_DIR = pathlib.Path(__file__).parent.resolve() +NEW_ARTIFACTS_DIR = SCRIPTS_DIR / "test_resources" / "new_artifacts_dir" +CURRENT_ARTIFACTS_DIR = SCRIPTS_DIR / "test_resources" / "current_artifacts_dir" +TEMP_DIR = SCRIPTS_DIR / "test_resources" / "temp" + + +class TestChangeSummary(unittest.TestCase): + def setUp(self): + # Clear temporary directory + shutil.rmtree(TEMP_DIR, ignore_errors=True) + # Create temporary directory + pathlib.Path(TEMP_DIR).mkdir() + + self.cs = ChangeSummary(NEW_ARTIFACTS_DIR, CURRENT_ARTIFACTS_DIR, TEMP_DIR, []) + + def test_raises_on_directory_not_found_new_artifacts_dir(self): + with self.assertRaises(DirectoryDoesNotExist): + ChangeSummary( + "invalid_artifact_dir", CURRENT_ARTIFACTS_DIR, TEMP_DIR, [] + ).detect_discovery_changes() + + def test_raises_on_directory_not_found_current_artifacts_dir(self): + with self.assertRaises(DirectoryDoesNotExist): + ChangeSummary( + NEW_ARTIFACTS_DIR, "invalid_artifact_dir", TEMP_DIR, [] + ).detect_discovery_changes() + + def test_raises_on_directory_not_found_temp_dir(self): + # Remove temporary directory + shutil.rmtree(TEMP_DIR, ignore_errors=True) + + with self.assertRaises(DirectoryDoesNotExist): + ChangeSummary( + NEW_ARTIFACTS_DIR, CURRENT_ARTIFACTS_DIR, "invalid_temp_dir", [] + ).detect_discovery_changes() + + # Create temporary directory + pathlib.Path(TEMP_DIR).mkdir() + + ChangeSummary( + NEW_ARTIFACTS_DIR, CURRENT_ARTIFACTS_DIR, TEMP_DIR, [] + ).detect_discovery_changes() + + def test_raises_on_directory_not_found(self): + with self.assertRaises(DirectoryDoesNotExist): + self.cs._raise_if_directory_not_found(directory="invalid_dir") + + def test_load_json_to_dataframe_returns_empty_df_if_file_path_invalid(self): + df = self.cs._load_json_to_dataframe(file_path="invalid_path") + self.assertTrue(df.empty) + + def test_load_json_to_dataframe_returns_expected_data(self): + doc_path = NEW_ARTIFACTS_DIR / "drive.v3.json" + df = self.cs._load_json_to_dataframe(file_path=doc_path) + self.assertEqual(df["name"].iloc[0], "drive") + self.assertEqual(df["version"].iloc[0], "v3") + + def test_get_discovery_differences_for_new_doc_returns_expected_dataframe(self): + df = self.cs._get_discovery_differences("drive.v3.json") + # Assume that `drive.v3.json` is a new discovery artifact that doesn't + # exist in `CURRENT_ARTIFACTS_DIR`. + self.assertEqual(df["Name"].iloc[0], "drive") + self.assertEqual(df["Version"].iloc[0], "v3") + + # All rows in the dataframe should have `True` in the `Added` column + # and `False` in the `Deleted` column. + # pd.Dataframe().all() will return `True` if all elements are `True`. + self.assertTrue(df["Added"].all()) + self.assertTrue((~df["Deleted"]).all()) + + # There should be 74 unique key differences + self.assertEqual(len(df), 74) + + # Expected Result for key 'schemas.File' + # Key Added Deleted Name Version ChangeType Count + # schemas.File True False drive v3 2 168 + self.assertTrue(df[df["Key"] == "schemas.File"].Added.iloc[0]) + self.assertFalse(df[df["Key"] == "schemas.File"].Deleted.iloc[0]) + self.assertEqual( + df[df["Key"] == "schemas.File"].ChangeType.iloc[0], ChangeType.ADDED + ) + self.assertEqual(df[df["Key"] == "schemas.File"].Count.iloc[0], 168) + + def test_get_discovery_differences_for_deleted_doc_returns_expected_dataframe(self): + df = self.cs._get_discovery_differences("cloudtasks.v2.json") + # Assuming that `cloudtasks.v2.json` is a discovery artifact that doesn't + # exist in `NEW_ARTIFACTS_DIR`. + self.assertEqual(df["Name"].iloc[0], "cloudtasks") + self.assertEqual(df["Version"].iloc[0], "v2") + + # All rows in the dataframe should have `False` in the `Added` column + # and `True` in the `Deleted` column. + # pd.Dataframe().all() will return `True` if all elements are `True`. + self.assertTrue((~df["Added"]).all()) + self.assertTrue(df["Deleted"].all()) + + # There should be 72 unique key differences + self.assertEqual(len(df), 72) + + # Expected Result for key 'schemas.Task' + # Key Added Deleted Name Version ChangeType Count + # schemas.Task False True cloudtasks v2 1 18 + self.assertFalse(df[df["Key"] == "schemas.Task"].Added.iloc[0]) + self.assertTrue(df[df["Key"] == "schemas.Task"].Deleted.iloc[0]) + self.assertEqual( + df[df["Key"] == "schemas.Task"].ChangeType.iloc[0], ChangeType.DELETED + ) + self.assertEqual(df[df["Key"] == "schemas.Task"].Count.iloc[0], 18) + + def test_get_discovery_differences_for_changed_doc_returns_expected_dataframe(self): + # Assuming that `bigquery.v2.json` is a discovery artifact has + # changed. There will be a mix of keys being added, changed or deleted. + df = self.cs._get_discovery_differences("bigquery.v2.json") + + self.assertEqual(df["Name"].iloc[0], "bigquery") + self.assertEqual(df["Version"].iloc[0], "v2") + + # There should be 28 unique key differences + # 11 unique keys changed, 13 unique keys added, 4 unique keys deleted + self.assertEqual(len(df), 28) + self.assertEqual(len(df[df["ChangeType"] == ChangeType.CHANGED]), 11) + self.assertEqual(len(df[df["ChangeType"] == ChangeType.ADDED]), 13) + self.assertEqual(len(df[df["ChangeType"] == ChangeType.DELETED]), 4) + + # Expected Result for key 'schemas.PrincipalComponentInfo' + # Key Added Deleted Name Version ChangeType Count + # schemas.PrincipalComponentInfo False True bigquery v2 1 10 + key = "schemas.PrincipalComponentInfo" + self.assertFalse(df[df["Key"] == key].Added.iloc[0]) + self.assertTrue(df[df["Key"] == key].Deleted.iloc[0]) + self.assertEqual(df[df["Key"] == key].ChangeType.iloc[0], ChangeType.DELETED) + self.assertEqual(df[df["Key"] == key].Count.iloc[0], 10) + + def test_build_summary_message_returns_expected_result(self): + msg = self.cs._build_summary_message(api_name="bigquery", is_feature=True) + self.assertEqual(msg, "feat(bigquery): update the api") + msg = self.cs._build_summary_message(api_name="bigquery", is_feature=False) + self.assertEqual(msg, "fix(bigquery): update the api") + + def test_get_stable_versions(self): + # These versions should be considered stable + s = pd.Series(["v1", "v1.4", "v1.4.5"]) + self.assertTrue(self.cs._get_stable_versions(s).all().iloc[0]) + + # These versions should not be considered stable + s = pd.Series(["v1b1", "v1alpha", "v1beta1"]) + self.assertTrue((~self.cs._get_stable_versions(s)).all().iloc[0]) + + def test_detect_discovery_changes(self): + files_changed = ["bigquery.v2.json", "cloudtasks.v2.json", "drive.v3.json"] + cs = ChangeSummary( + NEW_ARTIFACTS_DIR, CURRENT_ARTIFACTS_DIR, TEMP_DIR, files_changed + ) + cs.detect_discovery_changes() + print("test") + result = pd.read_csv(TEMP_DIR / "allapis.dataframe") + + # bigquery was added + # 28 key changes in total. + # 11 unique keys changed, 13 unique keys added, 4 unique keys deleted + self.assertEqual(len(result[result["Name"] == "bigquery"]), 28) + self.assertEqual( + len(result[(result["Name"] == "bigquery") & result["Added"]]), 13 + ) + self.assertEqual( + len(result[(result["Name"] == "bigquery") & result["Deleted"]]), 4 + ) + self.assertTrue(result[result["Name"] == "bigquery"].IsStable.all()) + self.assertTrue(result[result["Name"] == "bigquery"].IsFeatureAggregate.all()) + self.assertEqual( + result[result["Name"] == "bigquery"].Summary.iloc[0], + "feat(bigquery): update the api", + ) + + # cloudtasks was deleted + # 72 key changes in total. All 72 key changes should be deletions. + self.assertEqual(len(result[result["Name"] == "cloudtasks"]), 72) + self.assertEqual( + len(result[(result["Name"] == "cloudtasks") & result["Added"]]), 0 + ) + self.assertEqual( + len(result[(result["Name"] == "cloudtasks") & result["Deleted"]]), 72 + ) + self.assertTrue(result[(result["Name"] == "cloudtasks")].IsStable.all()) + self.assertTrue( + result[(result["Name"] == "cloudtasks")].IsFeatureAggregate.all() + ) + self.assertEqual( + result[(result["Name"] == "cloudtasks")].Summary.iloc[0], + "feat(cloudtasks): update the api", + ) + + # drive was updated + # 74 key changes in total. All 74 key changes should be additions + self.assertEqual(len(result[result["Name"] == "drive"]), 74) + self.assertEqual( + len(result[(result["Name"] == "drive") & result["Added"]]), 74 + ) + self.assertEqual( + len(result[(result["Name"] == "drive") & result["Deleted"]]), 0 + ) + self.assertTrue(result[(result["Name"] == "drive")].IsStable.all()) + self.assertTrue( + result[(result["Name"] == "drive")].IsFeatureAggregate.all() + ) + self.assertEqual( + result[(result["Name"] == "drive")].Summary.iloc[0], + "feat(drive): update the api", + ) + +if __name__ == "__main__": + unittest.main() diff --git a/scripts/createcommits.sh b/scripts/createcommits.sh new file mode 100755 index 00000000000..c6c23f3cd33 --- /dev/null +++ b/scripts/createcommits.sh @@ -0,0 +1,52 @@ +#!/bin/bash +# Copyright 2021 Google LLC + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# https://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# If this is a github job, configure git +if [[ $GITHUB_JOB ]]; then + git config --global user.name 'Yoshi Automation' + git config --global user.email 'yoshi-automation@google.com' +fi + +while read api; +do + name=`echo $api | cut -d '.' -f 1` + API_SUMMARY_PATH=temp/$name.verbose + + if [[ ! -f "temp/$name.sha" ]]; then + if [ $name = "index" ]; then + git add '../docs/dyn/index.md' + commitmsg='chore: update docs/dyn/index.md' + else + git add '../googleapiclient/discovery_cache/documents/'$name'.*.json' + git add '../docs/dyn/'$name'_*.html' + if [[ -f "$API_SUMMARY_PATH" ]]; then + commitmsg=`cat $API_SUMMARY_PATH` + else + commitmsg='chore('$name'): update the api' + fi + fi + git commit -m "$commitmsg" + git rev-parse HEAD>temp/$name'.sha' + git reset + fi +done < temp/changed_files + +# Add untracked files +git add "../googleapiclient/discovery_cache/documents/*.json" +git add "../docs/dyn/*.html" +commitmsg='chore(docs): Add new discovery artifacts and reference documents' +git commit -m "$commitmsg" + +exit 0 diff --git a/scripts/requirements.txt b/scripts/requirements.txt new file mode 100644 index 00000000000..0569a4b8ef4 --- /dev/null +++ b/scripts/requirements.txt @@ -0,0 +1 @@ +pandas==1.2.4 diff --git a/scripts/test_resources/current_artifacts_dir/bigquery.v2.json b/scripts/test_resources/current_artifacts_dir/bigquery.v2.json new file mode 100644 index 00000000000..b3428377e23 --- /dev/null +++ b/scripts/test_resources/current_artifacts_dir/bigquery.v2.json @@ -0,0 +1,6518 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/bigquery": { + "description": "View and manage your data in Google BigQuery" + }, + "https://www.googleapis.com/auth/bigquery.insertdata": { + "description": "Insert data into Google BigQuery" + }, + "https://www.googleapis.com/auth/bigquery.readonly": { + "description": "View your data in Google BigQuery" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud Platform data" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/devstorage.full_control": { + "description": "Manage your data and permissions in Google Cloud Storage" + }, + "https://www.googleapis.com/auth/devstorage.read_only": { + "description": "View your data in Google Cloud Storage" + }, + "https://www.googleapis.com/auth/devstorage.read_write": { + "description": "Manage your data in Google Cloud Storage" + } + } + } + }, + "basePath": "/bigquery/v2/", + "baseUrl": "https://bigquery.googleapis.com/bigquery/v2/", + "batchPath": "batch/bigquery/v2", + "description": "A data platform for customers to create, manage, share and query data.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/bigquery/", + "icons": { + "x16": "https://www.google.com/images/icons/product/search-16.gif", + "x32": "https://www.google.com/images/icons/product/search-32.gif" + }, + "id": "bigquery:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://bigquery.mtls.googleapis.com/", + "name": "bigquery", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "alt": { + "default": "json", + "description": "Data format for the response.", + "enum": [ + "json" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json" + ], + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "userIp": { + "description": "Deprecated. Please use quotaUser instead.", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "datasets": { + "methods": { + "delete": { + "description": "Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.", + "httpMethod": "DELETE", + "id": "bigquery.datasets.delete", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of dataset being deleted", + "location": "path", + "required": true, + "type": "string" + }, + "deleteContents": { + "description": "If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False", + "location": "query", + "type": "boolean" + }, + "projectId": { + "description": "Project ID of the dataset being deleted", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the dataset specified by datasetID.", + "httpMethod": "GET", + "id": "bigquery.datasets.get", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the requested dataset", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the requested dataset", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Creates a new empty dataset.", + "httpMethod": "POST", + "id": "bigquery.datasets.insert", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID of the new dataset", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets", + "request": { + "$ref": "Dataset" + }, + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all datasets in the specified project to which you have been granted the READER dataset role.", + "httpMethod": "GET", + "id": "bigquery.datasets.list", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "all": { + "description": "Whether to list all datasets, including hidden ones", + "location": "query", + "type": "boolean" + }, + "filter": { + "description": "An expression for filtering the results of the request by label. The syntax is \"labels.[:]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See Filtering datasets using labels for details.", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "The maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the datasets to be listed", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets", + "response": { + "$ref": "DatasetList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.", + "httpMethod": "PATCH", + "id": "bigquery.datasets.patch", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "request": { + "$ref": "Dataset" + }, + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.", + "httpMethod": "PUT", + "id": "bigquery.datasets.update", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "request": { + "$ref": "Dataset" + }, + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "jobs": { + "methods": { + "cancel": { + "description": "Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.", + "httpMethod": "POST", + "id": "bigquery.jobs.cancel", + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "jobId": { + "description": "[Required] Job ID of the job to cancel", + "location": "path", + "required": true, + "type": "string" + }, + "location": { + "description": "The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "[Required] Project ID of the job to cancel", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs/{jobId}/cancel", + "response": { + "$ref": "JobCancelResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.", + "httpMethod": "GET", + "id": "bigquery.jobs.get", + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "jobId": { + "description": "[Required] Job ID of the requested job", + "location": "path", + "required": true, + "type": "string" + }, + "location": { + "description": "The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "[Required] Project ID of the requested job", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs/{jobId}", + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "getQueryResults": { + "description": "Retrieves the results of a query job.", + "httpMethod": "GET", + "id": "bigquery.jobs.getQueryResults", + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "jobId": { + "description": "[Required] Job ID of the query job", + "location": "path", + "required": true, + "type": "string" + }, + "location": { + "description": "The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to read", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "[Required] Project ID of the query job", + "location": "path", + "required": true, + "type": "string" + }, + "startIndex": { + "description": "Zero-based index of the starting row", + "format": "uint64", + "location": "query", + "type": "string" + }, + "timeoutMs": { + "description": "How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false", + "format": "uint32", + "location": "query", + "type": "integer" + } + }, + "path": "projects/{projectId}/queries/{jobId}", + "response": { + "$ref": "GetQueryResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Starts a new asynchronous job. Requires the Can View project role.", + "httpMethod": "POST", + "id": "bigquery.jobs.insert", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "resumable": { + "multipart": true, + "path": "/resumable/upload/bigquery/v2/projects/{projectId}/jobs" + }, + "simple": { + "multipart": true, + "path": "/upload/bigquery/v2/projects/{projectId}/jobs" + } + } + }, + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID of the project that will be billed for the job", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ], + "supportsMediaUpload": true + }, + "list": { + "description": "Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.", + "httpMethod": "GET", + "id": "bigquery.jobs.list", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "allUsers": { + "description": "Whether to display jobs owned by all users in the project. Default false", + "location": "query", + "type": "boolean" + }, + "maxCreationTime": { + "description": "Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned", + "format": "uint64", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "minCreationTime": { + "description": "Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned", + "format": "uint64", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "parentJobId": { + "description": "If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the jobs to list", + "location": "path", + "required": true, + "type": "string" + }, + "projection": { + "description": "Restrict information returned to a set of selected fields", + "enum": [ + "full", + "minimal" + ], + "enumDescriptions": [ + "Includes all job data", + "Does not include the job configuration" + ], + "location": "query", + "type": "string" + }, + "stateFilter": { + "description": "Filter for job state", + "enum": [ + "done", + "pending", + "running" + ], + "enumDescriptions": [ + "Finished jobs", + "Pending jobs", + "Running jobs" + ], + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs", + "response": { + "$ref": "JobList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "query": { + "description": "Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.", + "httpMethod": "POST", + "id": "bigquery.jobs.query", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID of the project billed for the query", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/queries", + "request": { + "$ref": "QueryRequest" + }, + "response": { + "$ref": "QueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "models": { + "methods": { + "delete": { + "description": "Deletes the model specified by modelId from the dataset.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models/{modelsId}", + "httpMethod": "DELETE", + "id": "bigquery.models.delete", + "parameterOrder": [ + "projectId", + "datasetId", + "modelId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the model to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "modelId": { + "description": "Required. Model ID of the model to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the model to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the specified model resource by model ID.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models/{modelsId}", + "httpMethod": "GET", + "id": "bigquery.models.get", + "parameterOrder": [ + "projectId", + "datasetId", + "modelId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the requested model.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "modelId": { + "description": "Required. Model ID of the requested model.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the requested model.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}", + "response": { + "$ref": "Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists all models in the specified dataset. Requires the READER dataset role.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models", + "httpMethod": "GET", + "id": "bigquery.models.list", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the models to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "maxResults": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the models to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models", + "response": { + "$ref": "ListModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Patch specific fields in the specified model.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models/{modelsId}", + "httpMethod": "PATCH", + "id": "bigquery.models.patch", + "parameterOrder": [ + "projectId", + "datasetId", + "modelId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the model to patch.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "modelId": { + "description": "Required. Model ID of the model to patch.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the model to patch.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}", + "request": { + "$ref": "Model" + }, + "response": { + "$ref": "Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "projects": { + "methods": { + "getServiceAccount": { + "description": "Returns the email address of the service account for your project used for interactions with Google Cloud KMS.", + "httpMethod": "GET", + "id": "bigquery.projects.getServiceAccount", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID for which the service account is requested.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/serviceAccount", + "response": { + "$ref": "GetServiceAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists all projects to which you have been granted any project role.", + "httpMethod": "GET", + "id": "bigquery.projects.list", + "parameters": { + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + } + }, + "path": "projects", + "response": { + "$ref": "ProjectList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "routines": { + "methods": { + "delete": { + "description": "Deletes the routine specified by routineId from the dataset.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}", + "httpMethod": "DELETE", + "id": "bigquery.routines.delete", + "parameterOrder": [ + "projectId", + "datasetId", + "routineId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the routine to delete", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the routine to delete", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "routineId": { + "description": "Required. Routine ID of the routine to delete", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the specified routine resource by routine ID.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}", + "httpMethod": "GET", + "id": "bigquery.routines.get", + "parameterOrder": [ + "projectId", + "datasetId", + "routineId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the requested routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the requested routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "routineId": { + "description": "Required. Routine ID of the requested routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}", + "response": { + "$ref": "Routine" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Creates a new routine in the dataset.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines", + "httpMethod": "POST", + "id": "bigquery.routines.insert", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the new routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the new routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines", + "request": { + "$ref": "Routine" + }, + "response": { + "$ref": "Routine" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all routines in the specified dataset. Requires the READER dataset role.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines", + "httpMethod": "GET", + "id": "bigquery.routines.list", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the routines to list", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "If set, then only the Routines matching this filter are returned. The current supported form is either \"routine_type:\" or \"routineType:\", where is a RoutineType enum. Example: \"routineType:SCALAR_FUNCTION\".", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the routines to list", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines", + "response": { + "$ref": "ListRoutinesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "update": { + "description": "Updates information in an existing routine. The update method replaces the entire Routine resource.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}", + "httpMethod": "PUT", + "id": "bigquery.routines.update", + "parameterOrder": [ + "projectId", + "datasetId", + "routineId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the routine to update", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the routine to update", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "routineId": { + "description": "Required. Routine ID of the routine to update", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}", + "request": { + "$ref": "Routine" + }, + "response": { + "$ref": "Routine" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "rowAccessPolicies": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists all row access policies on the specified table.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies", + "httpMethod": "GET", + "id": "bigquery.rowAccessPolicies.list", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of row access policies to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the row access policies to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to list row access policies.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies", + "response": { + "$ref": "ListRowAccessPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "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": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "tabledata": { + "methods": { + "insertAll": { + "description": "Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.", + "httpMethod": "POST", + "id": "bigquery.tabledata.insertAll", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the destination table.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the destination table.", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the destination table.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll", + "request": { + "$ref": "TableDataInsertAllRequest" + }, + "response": { + "$ref": "TableDataInsertAllResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.insertdata", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Retrieves table data from a specified set of rows. Requires the READER dataset role.", + "httpMethod": "GET", + "id": "bigquery.tabledata.list", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to read", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, identifying the result set", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to read", + "location": "path", + "required": true, + "type": "string" + }, + "selectedFields": { + "description": "List of fields to return (comma-separated). If unspecified, all fields are returned", + "location": "query", + "type": "string" + }, + "startIndex": { + "description": "Zero-based index of the starting row to read", + "format": "uint64", + "location": "query", + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to read", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data", + "response": { + "$ref": "TableDataList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "tables": { + "methods": { + "delete": { + "description": "Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.", + "httpMethod": "DELETE", + "id": "bigquery.tables.delete", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to delete", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to delete", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to delete", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.", + "httpMethod": "GET", + "id": "bigquery.tables.get", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the requested table", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the requested table", + "location": "path", + "required": true, + "type": "string" + }, + "selectedFields": { + "description": "List of fields to return (comma-separated). If unspecified, all fields are returned", + "location": "query", + "type": "string" + }, + "tableId": { + "description": "Table ID of the requested table", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "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": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:getIamPolicy", + "httpMethod": "POST", + "id": "bigquery.tables.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Creates a new, empty table in the dataset.", + "httpMethod": "POST", + "id": "bigquery.tables.insert", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the new table", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the new table", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables", + "request": { + "$ref": "Table" + }, + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all tables in the specified dataset. Requires the READER dataset role.", + "httpMethod": "GET", + "id": "bigquery.tables.list", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the tables to list", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the tables to list", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables", + "response": { + "$ref": "TableList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.", + "httpMethod": "PATCH", + "id": "bigquery.tables.patch", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to update", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "request": { + "$ref": "Table" + }, + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigquery.tables.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigquery.tables.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "update": { + "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.", + "httpMethod": "PUT", + "id": "bigquery.tables.update", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to update", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "request": { + "$ref": "Table" + }, + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + }, + "revision": "20210313", + "rootUrl": "https://bigquery.googleapis.com/", + "schemas": { + "AggregateClassificationMetrics": { + "description": "Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows.", + "id": "AggregateClassificationMetrics", + "properties": { + "accuracy": { + "description": "Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "logLoss": { + "description": "Logarithmic Loss. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "precision": { + "description": "Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.", + "format": "double", + "type": "number" + }, + "recall": { + "description": "Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "rocAuc": { + "description": "Area Under a ROC Curve. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "threshold": { + "description": "Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Argument": { + "description": "Input/output argument of a function or a stored procedure.", + "id": "Argument", + "properties": { + "argumentKind": { + "description": "Optional. Defaults to FIXED_TYPE.", + "enum": [ + "ARGUMENT_KIND_UNSPECIFIED", + "FIXED_TYPE", + "ANY_TYPE" + ], + "enumDescriptions": [ + "", + "The argument is a variable with fully specified type, which can be a struct or an array, but not a table.", + "The argument is any type, including struct or array, but not a table. To be added: FIXED_TABLE, ANY_TABLE" + ], + "type": "string" + }, + "dataType": { + "$ref": "StandardSqlDataType", + "description": "Required unless argument_kind = ANY_TYPE." + }, + "mode": { + "description": "Optional. Specifies whether the argument is input or output. Can be set for procedures only.", + "enum": [ + "MODE_UNSPECIFIED", + "IN", + "OUT", + "INOUT" + ], + "enumDescriptions": [ + "", + "The argument is input-only.", + "The argument is output-only.", + "The argument is both an input and an output." + ], + "type": "string" + }, + "name": { + "description": "Optional. The name of this argument. Can be absent for function return argument.", + "type": "string" + } + }, + "type": "object" + }, + "ArimaCoefficients": { + "description": "Arima coefficients.", + "id": "ArimaCoefficients", + "properties": { + "autoRegressiveCoefficients": { + "description": "Auto-regressive coefficients, an array of double.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "interceptCoefficient": { + "description": "Intercept coefficient, just a double not an array.", + "format": "double", + "type": "number" + }, + "movingAverageCoefficients": { + "description": "Moving-average coefficients, an array of double.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArimaFittingMetrics": { + "description": "ARIMA model fitting metrics.", + "id": "ArimaFittingMetrics", + "properties": { + "aic": { + "description": "AIC.", + "format": "double", + "type": "number" + }, + "logLikelihood": { + "description": "Log-likelihood.", + "format": "double", + "type": "number" + }, + "variance": { + "description": "Variance.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ArimaForecastingMetrics": { + "description": "Model evaluation metrics for ARIMA forecasting models.", + "id": "ArimaForecastingMetrics", + "properties": { + "arimaFittingMetrics": { + "description": "Arima model fitting metrics.", + "items": { + "$ref": "ArimaFittingMetrics" + }, + "type": "array" + }, + "arimaSingleModelForecastingMetrics": { + "description": "Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.", + "items": { + "$ref": "ArimaSingleModelForecastingMetrics" + }, + "type": "array" + }, + "hasDrift": { + "description": "Whether Arima model fitted with drift or not. It is always false when d is not 1.", + "items": { + "type": "boolean" + }, + "type": "array" + }, + "nonSeasonalOrder": { + "description": "Non-seasonal order.", + "items": { + "$ref": "ArimaOrder" + }, + "type": "array" + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + }, + "timeSeriesId": { + "description": "Id to differentiate different time series for the large-scale case.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArimaModelInfo": { + "description": "Arima model information.", + "id": "ArimaModelInfo", + "properties": { + "arimaCoefficients": { + "$ref": "ArimaCoefficients", + "description": "Arima coefficients." + }, + "arimaFittingMetrics": { + "$ref": "ArimaFittingMetrics", + "description": "Arima fitting metrics." + }, + "hasDrift": { + "description": "Whether Arima model fitted with drift or not. It is always false when d is not 1.", + "type": "boolean" + }, + "nonSeasonalOrder": { + "$ref": "ArimaOrder", + "description": "Non-seasonal order." + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + }, + "timeSeriesId": { + "description": "The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.", + "type": "string" + } + }, + "type": "object" + }, + "ArimaOrder": { + "description": "Arima order, can be used for both non-seasonal and seasonal parts.", + "id": "ArimaOrder", + "properties": { + "d": { + "description": "Order of the differencing part.", + "format": "int64", + "type": "string" + }, + "p": { + "description": "Order of the autoregressive part.", + "format": "int64", + "type": "string" + }, + "q": { + "description": "Order of the moving-average part.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ArimaResult": { + "description": "(Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.", + "id": "ArimaResult", + "properties": { + "arimaModelInfo": { + "description": "This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.", + "items": { + "$ref": "ArimaModelInfo" + }, + "type": "array" + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArimaSingleModelForecastingMetrics": { + "description": "Model evaluation metrics for a single ARIMA forecasting model.", + "id": "ArimaSingleModelForecastingMetrics", + "properties": { + "arimaFittingMetrics": { + "$ref": "ArimaFittingMetrics", + "description": "Arima fitting metrics." + }, + "hasDrift": { + "description": "Is arima model fitted with drift or not. It is always false when d is not 1.", + "type": "boolean" + }, + "nonSeasonalOrder": { + "$ref": "ArimaOrder", + "description": "Non-seasonal order." + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + }, + "timeSeriesId": { + "description": "The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.", + "type": "string" + } + }, + "type": "object" + }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "BigQueryModelTraining": { + "id": "BigQueryModelTraining", + "properties": { + "currentIteration": { + "description": "[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.", + "format": "int32", + "type": "integer" + }, + "expectedTotalIterations": { + "description": "[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BigtableColumn": { + "id": "BigtableColumn", + "properties": { + "encoding": { + "description": "[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.", + "type": "string" + }, + "fieldName": { + "description": "[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.", + "type": "string" + }, + "onlyReadLatest": { + "description": "[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.", + "type": "boolean" + }, + "qualifierEncoded": { + "description": "[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.", + "format": "byte", + "type": "string" + }, + "qualifierString": { + "type": "string" + }, + "type": { + "description": "[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.", + "type": "string" + } + }, + "type": "object" + }, + "BigtableColumnFamily": { + "id": "BigtableColumnFamily", + "properties": { + "columns": { + "description": "[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.", + "items": { + "$ref": "BigtableColumn" + }, + "type": "array" + }, + "encoding": { + "description": "[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.", + "type": "string" + }, + "familyId": { + "description": "Identifier of the column family.", + "type": "string" + }, + "onlyReadLatest": { + "description": "[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.", + "type": "boolean" + }, + "type": { + "description": "[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.", + "type": "string" + } + }, + "type": "object" + }, + "BigtableOptions": { + "id": "BigtableOptions", + "properties": { + "columnFamilies": { + "description": "[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.", + "items": { + "$ref": "BigtableColumnFamily" + }, + "type": "array" + }, + "ignoreUnspecifiedColumnFamilies": { + "description": "[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.", + "type": "boolean" + }, + "readRowkeyAsString": { + "description": "[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.", + "type": "boolean" + } + }, + "type": "object" + }, + "BinaryClassificationMetrics": { + "description": "Evaluation metrics for binary classification/classifier models.", + "id": "BinaryClassificationMetrics", + "properties": { + "aggregateClassificationMetrics": { + "$ref": "AggregateClassificationMetrics", + "description": "Aggregate classification metrics." + }, + "binaryConfusionMatrixList": { + "description": "Binary confusion matrix at multiple thresholds.", + "items": { + "$ref": "BinaryConfusionMatrix" + }, + "type": "array" + }, + "negativeLabel": { + "description": "Label representing the negative class.", + "type": "string" + }, + "positiveLabel": { + "description": "Label representing the positive class.", + "type": "string" + } + }, + "type": "object" + }, + "BinaryConfusionMatrix": { + "description": "Confusion matrix for binary classification models.", + "id": "BinaryConfusionMatrix", + "properties": { + "accuracy": { + "description": "The fraction of predictions given the correct label.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The equally weighted average of recall and precision.", + "format": "double", + "type": "number" + }, + "falseNegatives": { + "description": "Number of false samples predicted as false.", + "format": "int64", + "type": "string" + }, + "falsePositives": { + "description": "Number of false samples predicted as true.", + "format": "int64", + "type": "string" + }, + "positiveClassThreshold": { + "description": "Threshold value used when computing each of the following metric.", + "format": "double", + "type": "number" + }, + "precision": { + "description": "The fraction of actual positive predictions that had positive actual labels.", + "format": "double", + "type": "number" + }, + "recall": { + "description": "The fraction of actual positive labels that were given a positive prediction.", + "format": "double", + "type": "number" + }, + "trueNegatives": { + "description": "Number of true samples predicted as false.", + "format": "int64", + "type": "string" + }, + "truePositives": { + "description": "Number of true samples predicted as true.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "BqmlIterationResult": { + "id": "BqmlIterationResult", + "properties": { + "durationMs": { + "description": "[Output-only, Beta] Time taken to run the training iteration in milliseconds.", + "format": "int64", + "type": "string" + }, + "evalLoss": { + "description": "[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.", + "format": "double", + "type": "number" + }, + "index": { + "description": "[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.", + "format": "int32", + "type": "integer" + }, + "learnRate": { + "description": "[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.", + "format": "double", + "type": "number" + }, + "trainingLoss": { + "description": "[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "BqmlTrainingRun": { + "id": "BqmlTrainingRun", + "properties": { + "iterationResults": { + "description": "[Output-only, Beta] List of each iteration results.", + "items": { + "$ref": "BqmlIterationResult" + }, + "type": "array" + }, + "startTime": { + "description": "[Output-only, Beta] Training run start time in milliseconds since the epoch.", + "format": "date-time", + "type": "string" + }, + "state": { + "description": "[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.", + "type": "string" + }, + "trainingOptions": { + "description": "[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.", + "properties": { + "earlyStop": { + "type": "boolean" + }, + "l1Reg": { + "format": "double", + "type": "number" + }, + "l2Reg": { + "format": "double", + "type": "number" + }, + "learnRate": { + "format": "double", + "type": "number" + }, + "learnRateStrategy": { + "type": "string" + }, + "lineSearchInitLearnRate": { + "format": "double", + "type": "number" + }, + "maxIteration": { + "format": "int64", + "type": "string" + }, + "minRelProgress": { + "format": "double", + "type": "number" + }, + "warmStart": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "CategoricalValue": { + "description": "Representative value of a categorical feature.", + "id": "CategoricalValue", + "properties": { + "categoryCounts": { + "description": "Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category \"_OTHER_\" and count as aggregate counts of remaining categories.", + "items": { + "$ref": "CategoryCount" + }, + "type": "array" + } + }, + "type": "object" + }, + "CategoryCount": { + "description": "Represents the count of a single category within the cluster.", + "id": "CategoryCount", + "properties": { + "category": { + "description": "The name of category.", + "type": "string" + }, + "count": { + "description": "The count of training samples matching the category within the cluster.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Cluster": { + "description": "Message containing the information about one cluster.", + "id": "Cluster", + "properties": { + "centroidId": { + "description": "Centroid id.", + "format": "int64", + "type": "string" + }, + "count": { + "description": "Count of training data rows that were assigned to this cluster.", + "format": "int64", + "type": "string" + }, + "featureValues": { + "description": "Values of highly variant features for this cluster.", + "items": { + "$ref": "FeatureValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClusterInfo": { + "description": "Information about a single cluster for clustering model.", + "id": "ClusterInfo", + "properties": { + "centroidId": { + "description": "Centroid id.", + "format": "int64", + "type": "string" + }, + "clusterRadius": { + "description": "Cluster radius, the average distance from centroid to each point assigned to the cluster.", + "format": "double", + "type": "number" + }, + "clusterSize": { + "description": "Cluster size, the total number of points assigned to the cluster.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Clustering": { + "id": "Clustering", + "properties": { + "fields": { + "description": "[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClusteringMetrics": { + "description": "Evaluation metrics for clustering models.", + "id": "ClusteringMetrics", + "properties": { + "clusters": { + "description": "Information for all clusters.", + "items": { + "$ref": "Cluster" + }, + "type": "array" + }, + "daviesBouldinIndex": { + "description": "Davies-Bouldin index.", + "format": "double", + "type": "number" + }, + "meanSquaredDistance": { + "description": "Mean of squared distances between each sample to its cluster centroid.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ConfusionMatrix": { + "description": "Confusion matrix for multi-class classification models.", + "id": "ConfusionMatrix", + "properties": { + "confidenceThreshold": { + "description": "Confidence threshold used when computing the entries of the confusion matrix.", + "format": "double", + "type": "number" + }, + "rows": { + "description": "One row per actual label.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConnectionProperty": { + "id": "ConnectionProperty", + "properties": { + "key": { + "description": "[Required] Name of the connection property to set.", + "type": "string" + }, + "value": { + "description": "[Required] Value of the connection property.", + "type": "string" + } + }, + "type": "object" + }, + "CsvOptions": { + "id": "CsvOptions", + "properties": { + "allowJaggedRows": { + "description": "[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.", + "type": "boolean" + }, + "allowQuotedNewlines": { + "description": "[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.", + "type": "boolean" + }, + "encoding": { + "description": "[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.", + "type": "string" + }, + "fieldDelimiter": { + "description": "[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence \"\\t\" to specify a tab separator. The default value is a comma (',').", + "type": "string" + }, + "quote": { + "default": "\"", + "description": "[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.", + "pattern": ".?", + "type": "string" + }, + "skipLeadingRows": { + "description": "[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DataSplitResult": { + "description": "Data split result. This contains references to the training and evaluation data tables that were used to train the model.", + "id": "DataSplitResult", + "properties": { + "evaluationTable": { + "$ref": "TableReference", + "description": "Table reference of the evaluation data after split." + }, + "trainingTable": { + "$ref": "TableReference", + "description": "Table reference of the training data after split." + } + }, + "type": "object" + }, + "Dataset": { + "id": "Dataset", + "properties": { + "access": { + "description": "[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;", + "items": { + "properties": { + "dataset": { + "$ref": "DatasetAccessEntry", + "description": "[Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation." + }, + "domain": { + "description": "[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\". Maps to IAM policy member \"domain:DOMAIN\".", + "type": "string" + }, + "groupByEmail": { + "description": "[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member \"group:GROUP\".", + "type": "string" + }, + "iamMember": { + "description": "[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.", + "type": "string" + }, + "role": { + "description": "[Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", + "type": "string" + }, + "routine": { + "$ref": "RoutineReference", + "description": "[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation." + }, + "specialGroup": { + "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", + "type": "string" + }, + "userByEmail": { + "description": "[Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member \"user:EMAIL\" or \"serviceAccount:EMAIL\".", + "type": "string" + }, + "view": { + "$ref": "TableReference", + "description": "[Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation." + } + }, + "type": "object" + }, + "type": "array" + }, + "creationTime": { + "description": "[Output-only] The time when this dataset was created, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "datasetReference": { + "$ref": "DatasetReference", + "description": "[Required] A reference that identifies the dataset." + }, + "defaultEncryptionConfiguration": { + "$ref": "EncryptionConfiguration" + }, + "defaultPartitionExpirationMs": { + "description": "[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.", + "format": "int64", + "type": "string" + }, + "defaultTableExpirationMs": { + "description": "[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "[Optional] A user-friendly description of the dataset.", + "type": "string" + }, + "etag": { + "description": "[Output-only] A hash of the resource.", + "type": "string" + }, + "friendlyName": { + "description": "[Optional] A descriptive name for the dataset.", + "type": "string" + }, + "id": { + "description": "[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.", + "type": "string" + }, + "kind": { + "default": "bigquery#dataset", + "description": "[Output-only] The resource type.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.", + "type": "object" + }, + "lastModifiedTime": { + "description": "[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "location": { + "description": "The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.", + "type": "string" + }, + "satisfiesPZS": { + "description": "[Output-only] Reserved for future use.", + "type": "boolean" + }, + "selfLink": { + "description": "[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.", + "type": "string" + } + }, + "type": "object" + }, + "DatasetAccessEntry": { + "id": "DatasetAccessEntry", + "properties": { + "dataset": { + "$ref": "DatasetReference", + "description": "[Required] The dataset this entry applies to." + }, + "target_types": { + "items": { + "properties": { + "targetType": { + "description": "[Required] Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS: This entry applies to all views in the dataset.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "DatasetList": { + "id": "DatasetList", + "properties": { + "datasets": { + "description": "An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.", + "items": { + "properties": { + "datasetReference": { + "$ref": "DatasetReference", + "description": "The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID." + }, + "friendlyName": { + "description": "A descriptive name for the dataset, if one exists.", + "type": "string" + }, + "id": { + "description": "The fully-qualified, unique, opaque ID of the dataset.", + "type": "string" + }, + "kind": { + "default": "bigquery#dataset", + "description": "The resource type. This property always returns the value \"bigquery#dataset\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this dataset. You can use these to organize and group your datasets.", + "type": "object" + }, + "location": { + "description": "The geographic location where the data resides.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "etag": { + "description": "A hash value of the results page. You can use this property to determine if the page has changed since the last request.", + "type": "string" + }, + "kind": { + "default": "bigquery#datasetList", + "description": "The list type. This property always returns the value \"bigquery#datasetList\".", + "type": "string" + }, + "nextPageToken": { + "description": "A token that can be used to request the next results page. This property is omitted on the final results page.", + "type": "string" + } + }, + "type": "object" + }, + "DatasetReference": { + "id": "DatasetReference", + "properties": { + "datasetId": { + "annotations": { + "required": [ + "bigquery.datasets.update" + ] + }, + "description": "[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.", + "type": "string" + }, + "projectId": { + "annotations": { + "required": [ + "bigquery.datasets.update" + ] + }, + "description": "[Optional] The ID of the project containing this dataset.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationTableProperties": { + "id": "DestinationTableProperties", + "properties": { + "description": { + "description": "[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.", + "type": "string" + }, + "friendlyName": { + "description": "[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.", + "type": "object" + } + }, + "type": "object" + }, + "DimensionalityReductionMetrics": { + "description": "Model evaluation metrics for dimensionality reduction models.", + "id": "DimensionalityReductionMetrics", + "properties": { + "totalExplainedVarianceRatio": { + "description": "Total percentage of variance explained by the selected principal components.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "EncryptionConfiguration": { + "id": "EncryptionConfiguration", + "properties": { + "kmsKeyName": { + "description": "[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.", + "type": "string" + } + }, + "type": "object" + }, + "Entry": { + "description": "A single entry in the confusion matrix.", + "id": "Entry", + "properties": { + "itemCount": { + "description": "Number of items being predicted as this label.", + "format": "int64", + "type": "string" + }, + "predictedLabel": { + "description": "The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.", + "type": "string" + } + }, + "type": "object" + }, + "ErrorProto": { + "id": "ErrorProto", + "properties": { + "debugInfo": { + "description": "Debugging information. This property is internal to Google and should not be used.", + "type": "string" + }, + "location": { + "description": "Specifies where the error occurred, if present.", + "type": "string" + }, + "message": { + "description": "A human-readable description of the error.", + "type": "string" + }, + "reason": { + "description": "A short error code that summarizes the error.", + "type": "string" + } + }, + "type": "object" + }, + "EvaluationMetrics": { + "description": "Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.", + "id": "EvaluationMetrics", + "properties": { + "arimaForecastingMetrics": { + "$ref": "ArimaForecastingMetrics", + "description": "Populated for ARIMA models." + }, + "binaryClassificationMetrics": { + "$ref": "BinaryClassificationMetrics", + "description": "Populated for binary classification/classifier models." + }, + "clusteringMetrics": { + "$ref": "ClusteringMetrics", + "description": "Populated for clustering models." + }, + "dimensionalityReductionMetrics": { + "$ref": "DimensionalityReductionMetrics", + "description": "Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA." + }, + "multiClassClassificationMetrics": { + "$ref": "MultiClassClassificationMetrics", + "description": "Populated for multi-class classification/classifier models." + }, + "rankingMetrics": { + "$ref": "RankingMetrics", + "description": "Populated for implicit feedback type matrix factorization models." + }, + "regressionMetrics": { + "$ref": "RegressionMetrics", + "description": "Populated for regression models and explicit feedback type matrix factorization models." + } + }, + "type": "object" + }, + "ExplainQueryStage": { + "id": "ExplainQueryStage", + "properties": { + "completedParallelInputs": { + "description": "Number of parallel input segments completed.", + "format": "int64", + "type": "string" + }, + "computeMsAvg": { + "description": "Milliseconds the average shard spent on CPU-bound tasks.", + "format": "int64", + "type": "string" + }, + "computeMsMax": { + "description": "Milliseconds the slowest shard spent on CPU-bound tasks.", + "format": "int64", + "type": "string" + }, + "computeRatioAvg": { + "description": "Relative amount of time the average shard spent on CPU-bound tasks.", + "format": "double", + "type": "number" + }, + "computeRatioMax": { + "description": "Relative amount of time the slowest shard spent on CPU-bound tasks.", + "format": "double", + "type": "number" + }, + "endMs": { + "description": "Stage end time represented as milliseconds since epoch.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "Unique ID for stage within plan.", + "format": "int64", + "type": "string" + }, + "inputStages": { + "description": "IDs for stages that are inputs to this stage.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Human-readable name for stage.", + "type": "string" + }, + "parallelInputs": { + "description": "Number of parallel input segments to be processed.", + "format": "int64", + "type": "string" + }, + "readMsAvg": { + "description": "Milliseconds the average shard spent reading input.", + "format": "int64", + "type": "string" + }, + "readMsMax": { + "description": "Milliseconds the slowest shard spent reading input.", + "format": "int64", + "type": "string" + }, + "readRatioAvg": { + "description": "Relative amount of time the average shard spent reading input.", + "format": "double", + "type": "number" + }, + "readRatioMax": { + "description": "Relative amount of time the slowest shard spent reading input.", + "format": "double", + "type": "number" + }, + "recordsRead": { + "description": "Number of records read into the stage.", + "format": "int64", + "type": "string" + }, + "recordsWritten": { + "description": "Number of records written by the stage.", + "format": "int64", + "type": "string" + }, + "shuffleOutputBytes": { + "description": "Total number of bytes written to shuffle.", + "format": "int64", + "type": "string" + }, + "shuffleOutputBytesSpilled": { + "description": "Total number of bytes written to shuffle and spilled to disk.", + "format": "int64", + "type": "string" + }, + "slotMs": { + "description": "Slot-milliseconds used by the stage.", + "format": "int64", + "type": "string" + }, + "startMs": { + "description": "Stage start time represented as milliseconds since epoch.", + "format": "int64", + "type": "string" + }, + "status": { + "description": "Current status for the stage.", + "type": "string" + }, + "steps": { + "description": "List of operations within the stage in dependency order (approximately chronological).", + "items": { + "$ref": "ExplainQueryStep" + }, + "type": "array" + }, + "waitMsAvg": { + "description": "Milliseconds the average shard spent waiting to be scheduled.", + "format": "int64", + "type": "string" + }, + "waitMsMax": { + "description": "Milliseconds the slowest shard spent waiting to be scheduled.", + "format": "int64", + "type": "string" + }, + "waitRatioAvg": { + "description": "Relative amount of time the average shard spent waiting to be scheduled.", + "format": "double", + "type": "number" + }, + "waitRatioMax": { + "description": "Relative amount of time the slowest shard spent waiting to be scheduled.", + "format": "double", + "type": "number" + }, + "writeMsAvg": { + "description": "Milliseconds the average shard spent on writing output.", + "format": "int64", + "type": "string" + }, + "writeMsMax": { + "description": "Milliseconds the slowest shard spent on writing output.", + "format": "int64", + "type": "string" + }, + "writeRatioAvg": { + "description": "Relative amount of time the average shard spent on writing output.", + "format": "double", + "type": "number" + }, + "writeRatioMax": { + "description": "Relative amount of time the slowest shard spent on writing output.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ExplainQueryStep": { + "id": "ExplainQueryStep", + "properties": { + "kind": { + "description": "Machine-readable operation type.", + "type": "string" + }, + "substeps": { + "description": "Human-readable stage descriptions.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Explanation": { + "description": "Explanation for a single feature.", + "id": "Explanation", + "properties": { + "attribution": { + "description": "Attribution of feature.", + "format": "double", + "type": "number" + }, + "featureName": { + "description": "Full name of the feature. For non-numerical features, will be formatted like .. Overall size of feature name will always be truncated to first 120 characters.", + "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" + }, + "ExternalDataConfiguration": { + "id": "ExternalDataConfiguration", + "properties": { + "autodetect": { + "description": "Try to detect schema and format options automatically. Any option specified explicitly will be honored.", + "type": "boolean" + }, + "bigtableOptions": { + "$ref": "BigtableOptions", + "description": "[Optional] Additional options if sourceFormat is set to BIGTABLE." + }, + "compression": { + "description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.", + "type": "string" + }, + "connectionId": { + "description": "[Optional, Trusted Tester] Connection for external data source.", + "type": "string" + }, + "csvOptions": { + "$ref": "CsvOptions", + "description": "Additional properties to set if sourceFormat is set to CSV." + }, + "googleSheetsOptions": { + "$ref": "GoogleSheetsOptions", + "description": "[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS." + }, + "hivePartitioningOptions": { + "$ref": "HivePartitioningOptions", + "description": "[Optional] Options to configure hive partitioning support." + }, + "ignoreUnknownValues": { + "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.", + "type": "boolean" + }, + "maxBadRecords": { + "description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.", + "format": "int32", + "type": "integer" + }, + "parquetOptions": { + "$ref": "ParquetOptions", + "description": "Additional properties to set if sourceFormat is set to Parquet." + }, + "schema": { + "$ref": "TableSchema", + "description": "[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats." + }, + "sourceFormat": { + "description": "[Required] The data format. For CSV files, specify \"CSV\". For Google sheets, specify \"GOOGLE_SHEETS\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro files, specify \"AVRO\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\". [Beta] For Google Cloud Bigtable, specify \"BIGTABLE\".", + "type": "string" + }, + "sourceUris": { + "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FeatureValue": { + "description": "Representative value of a single feature within the cluster.", + "id": "FeatureValue", + "properties": { + "categoricalValue": { + "$ref": "CategoricalValue", + "description": "The categorical feature value." + }, + "featureColumn": { + "description": "The feature column name.", + "type": "string" + }, + "numericalValue": { + "description": "The numerical feature value. This is the centroid value for this feature.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GetIamPolicyRequest": { + "description": "Request message for `GetIamPolicy` method.", + "id": "GetIamPolicyRequest", + "properties": { + "options": { + "$ref": "GetPolicyOptions", + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." + } + }, + "type": "object" + }, + "GetPolicyOptions": { + "description": "Encapsulates settings provided to GetIamPolicy.", + "id": "GetPolicyOptions", + "properties": { + "requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GetQueryResultsResponse": { + "id": "GetQueryResultsResponse", + "properties": { + "cacheHit": { + "description": "Whether the query result was fetched from the query cache.", + "type": "boolean" + }, + "errors": { + "description": "[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "etag": { + "description": "A hash of this response.", + "type": "string" + }, + "jobComplete": { + "description": "Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.", + "type": "boolean" + }, + "jobReference": { + "$ref": "JobReference", + "description": "Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults)." + }, + "kind": { + "default": "bigquery#getQueryResultsResponse", + "description": "The resource type of the response.", + "type": "string" + }, + "numDmlAffectedRows": { + "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.", + "format": "int64", + "type": "string" + }, + "pageToken": { + "description": "A token used for paging results.", + "type": "string" + }, + "rows": { + "description": "An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.", + "items": { + "$ref": "TableRow" + }, + "type": "array" + }, + "schema": { + "$ref": "TableSchema", + "description": "The schema of the results. Present only when the query completes successfully." + }, + "totalBytesProcessed": { + "description": "The total number of bytes processed for this query.", + "format": "int64", + "type": "string" + }, + "totalRows": { + "description": "The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "GetServiceAccountResponse": { + "id": "GetServiceAccountResponse", + "properties": { + "email": { + "description": "The service account email address.", + "type": "string" + }, + "kind": { + "default": "bigquery#getServiceAccountResponse", + "description": "The resource type of the response.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalExplanation": { + "description": "Global explanations containing the top most important features after training.", + "id": "GlobalExplanation", + "properties": { + "classLabel": { + "description": "Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.", + "type": "string" + }, + "explanations": { + "description": "A list of the top global explanations. Sorted by absolute value of attribution in descending order.", + "items": { + "$ref": "Explanation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleSheetsOptions": { + "id": "GoogleSheetsOptions", + "properties": { + "range": { + "description": "[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20", + "type": "string" + }, + "skipLeadingRows": { + "description": "[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "HivePartitioningOptions": { + "id": "HivePartitioningOptions", + "properties": { + "mode": { + "description": "[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.", + "type": "string" + }, + "requirePartitionFilter": { + "description": "[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.", + "type": "boolean" + }, + "sourceUriPrefix": { + "description": "[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).", + "type": "string" + } + }, + "type": "object" + }, + "IterationResult": { + "description": "Information about a single iteration of the training run.", + "id": "IterationResult", + "properties": { + "arimaResult": { + "$ref": "ArimaResult" + }, + "clusterInfos": { + "description": "Information about top clusters for clustering models.", + "items": { + "$ref": "ClusterInfo" + }, + "type": "array" + }, + "durationMs": { + "description": "Time taken to run the iteration in milliseconds.", + "format": "int64", + "type": "string" + }, + "evalLoss": { + "description": "Loss computed on the eval data at the end of iteration.", + "format": "double", + "type": "number" + }, + "index": { + "description": "Index of the iteration, 0 based.", + "format": "int32", + "type": "integer" + }, + "learnRate": { + "description": "Learn rate used for this iteration.", + "format": "double", + "type": "number" + }, + "principalComponentInfos": { + "description": "The information of the principal components.", + "items": { + "$ref": "PrincipalComponentInfo" + }, + "type": "array" + }, + "trainingLoss": { + "description": "Loss computed on the training data at the end of iteration.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Job": { + "id": "Job", + "properties": { + "configuration": { + "$ref": "JobConfiguration", + "description": "[Required] Describes the job configuration." + }, + "etag": { + "description": "[Output-only] A hash of this resource.", + "type": "string" + }, + "id": { + "description": "[Output-only] Opaque ID field of the job", + "type": "string" + }, + "jobReference": { + "$ref": "JobReference", + "description": "[Optional] Reference describing the unique-per-user name of the job." + }, + "kind": { + "default": "bigquery#job", + "description": "[Output-only] The type of the resource.", + "type": "string" + }, + "selfLink": { + "description": "[Output-only] A URL that can be used to access this resource again.", + "type": "string" + }, + "statistics": { + "$ref": "JobStatistics", + "description": "[Output-only] Information about the job, including starting time and ending time of the job." + }, + "status": { + "$ref": "JobStatus", + "description": "[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete." + }, + "user_email": { + "description": "[Output-only] Email address of the user who ran the job.", + "type": "string" + } + }, + "type": "object" + }, + "JobCancelResponse": { + "id": "JobCancelResponse", + "properties": { + "job": { + "$ref": "Job", + "description": "The final state of the job." + }, + "kind": { + "default": "bigquery#jobCancelResponse", + "description": "The resource type of the response.", + "type": "string" + } + }, + "type": "object" + }, + "JobConfiguration": { + "id": "JobConfiguration", + "properties": { + "copy": { + "$ref": "JobConfigurationTableCopy", + "description": "[Pick one] Copies a table." + }, + "dryRun": { + "description": "[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.", + "type": "boolean" + }, + "extract": { + "$ref": "JobConfigurationExtract", + "description": "[Pick one] Configures an extract job." + }, + "jobTimeoutMs": { + "description": "[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.", + "format": "int64", + "type": "string" + }, + "jobType": { + "description": "[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "load": { + "$ref": "JobConfigurationLoad", + "description": "[Pick one] Configures a load job." + }, + "query": { + "$ref": "JobConfigurationQuery", + "description": "[Pick one] Configures a query job." + } + }, + "type": "object" + }, + "JobConfigurationExtract": { + "id": "JobConfigurationExtract", + "properties": { + "compression": { + "description": "[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.", + "type": "string" + }, + "destinationFormat": { + "description": "[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.", + "type": "string" + }, + "destinationUri": { + "description": "[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.", + "type": "string" + }, + "destinationUris": { + "description": "[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fieldDelimiter": { + "description": "[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.", + "type": "string" + }, + "printHeader": { + "default": "true", + "description": "[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.", + "type": "boolean" + }, + "sourceModel": { + "$ref": "ModelReference", + "description": "A reference to the model being exported." + }, + "sourceTable": { + "$ref": "TableReference", + "description": "A reference to the table being exported." + }, + "useAvroLogicalTypes": { + "description": "[Optional] If destinationFormat is set to \"AVRO\", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.", + "type": "boolean" + } + }, + "type": "object" + }, + "JobConfigurationLoad": { + "id": "JobConfigurationLoad", + "properties": { + "allowJaggedRows": { + "description": "[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.", + "type": "boolean" + }, + "allowQuotedNewlines": { + "description": "Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.", + "type": "boolean" + }, + "autodetect": { + "description": "[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.", + "type": "boolean" + }, + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered." + }, + "createDisposition": { + "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + }, + "decimalTargetTypes": { + "description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC ([Preview](/products/#product-launch-stages)), and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", + "items": { + "type": "string" + }, + "type": "array" + }, + "destinationEncryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "destinationTable": { + "$ref": "TableReference", + "description": "[Required] The destination table to load the data into." + }, + "destinationTableProperties": { + "$ref": "DestinationTableProperties", + "description": "[Beta] [Optional] Properties with which to create the destination table if it is new." + }, + "encoding": { + "description": "[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.", + "type": "string" + }, + "fieldDelimiter": { + "description": "[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence \"\\t\" to specify a tab separator. The default value is a comma (',').", + "type": "string" + }, + "hivePartitioningOptions": { + "$ref": "HivePartitioningOptions", + "description": "[Optional] Options to configure hive partitioning support." + }, + "ignoreUnknownValues": { + "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names", + "type": "boolean" + }, + "jsonExtension": { + "description": "[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.", + "type": "string" + }, + "maxBadRecords": { + "description": "[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.", + "format": "int32", + "type": "integer" + }, + "nullMarker": { + "description": "[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.", + "type": "string" + }, + "parquetOptions": { + "$ref": "ParquetOptions", + "description": "[Optional] Options to configure parquet support." + }, + "projectionFields": { + "description": "If sourceFormat is set to \"DATASTORE_BACKUP\", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.", + "items": { + "type": "string" + }, + "type": "array" + }, + "quote": { + "default": "\"", + "description": "[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.", + "pattern": ".?", + "type": "string" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "schema": { + "$ref": "TableSchema", + "description": "[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore." + }, + "schemaInline": { + "description": "[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\".", + "type": "string" + }, + "schemaInlineFormat": { + "description": "[Deprecated] The format of the schemaInline property.", + "type": "string" + }, + "schemaUpdateOptions": { + "description": "Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", + "items": { + "type": "string" + }, + "type": "array" + }, + "skipLeadingRows": { + "description": "[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.", + "format": "int32", + "type": "integer" + }, + "sourceFormat": { + "description": "[Optional] The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro, specify \"AVRO\". For parquet, specify \"PARQUET\". For orc, specify \"ORC\". The default value is CSV.", + "type": "string" + }, + "sourceUris": { + "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "useAvroLogicalTypes": { + "description": "[Optional] If sourceFormat is set to \"AVRO\", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).", + "type": "boolean" + }, + "writeDisposition": { + "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + } + }, + "type": "object" + }, + "JobConfigurationQuery": { + "id": "JobConfigurationQuery", + "properties": { + "allowLargeResults": { + "default": "false", + "description": "[Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.", + "type": "boolean" + }, + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered." + }, + "connectionProperties": { + "description": "Connection properties.", + "items": { + "$ref": "ConnectionProperty" + }, + "type": "array" + }, + "createDisposition": { + "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + }, + "createSession": { + "description": "If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.", + "type": "boolean" + }, + "defaultDataset": { + "$ref": "DatasetReference", + "description": "[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names." + }, + "destinationEncryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "destinationTable": { + "$ref": "TableReference", + "description": "[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size." + }, + "flattenResults": { + "default": "true", + "description": "[Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.", + "type": "boolean" + }, + "maximumBillingTier": { + "default": "1", + "description": "[Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.", + "format": "int32", + "type": "integer" + }, + "maximumBytesBilled": { + "description": "[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.", + "format": "int64", + "type": "string" + }, + "parameterMode": { + "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.", + "type": "string" + }, + "preserveNulls": { + "description": "[Deprecated] This property is deprecated.", + "type": "boolean" + }, + "priority": { + "description": "[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.", + "type": "string" + }, + "query": { + "description": "[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.", + "type": "string" + }, + "queryParameters": { + "description": "Query parameters for standard SQL queries.", + "items": { + "$ref": "QueryParameter" + }, + "type": "array" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "schemaUpdateOptions": { + "description": "Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tableDefinitions": { + "additionalProperties": { + "$ref": "ExternalDataConfiguration" + }, + "description": "[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.", + "type": "object" + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "useLegacySql": { + "default": "true", + "description": "Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.", + "type": "boolean" + }, + "useQueryCache": { + "default": "true", + "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.", + "type": "boolean" + }, + "userDefinedFunctionResources": { + "description": "Describes user-defined function resources used in the query.", + "items": { + "$ref": "UserDefinedFunctionResource" + }, + "type": "array" + }, + "writeDisposition": { + "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + } + }, + "type": "object" + }, + "JobConfigurationTableCopy": { + "id": "JobConfigurationTableCopy", + "properties": { + "createDisposition": { + "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + }, + "destinationEncryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "destinationExpirationTime": { + "description": "[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.", + "type": "any" + }, + "destinationTable": { + "$ref": "TableReference", + "description": "[Required] The destination table" + }, + "operationType": { + "description": "[Optional] Supported operation types in table copy job.", + "type": "string" + }, + "sourceTable": { + "$ref": "TableReference", + "description": "[Pick one] Source table to copy." + }, + "sourceTables": { + "description": "[Pick one] Source tables to copy.", + "items": { + "$ref": "TableReference" + }, + "type": "array" + }, + "writeDisposition": { + "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + } + }, + "type": "object" + }, + "JobList": { + "id": "JobList", + "properties": { + "etag": { + "description": "A hash of this page of results.", + "type": "string" + }, + "jobs": { + "description": "List of jobs that were requested.", + "items": { + "properties": { + "configuration": { + "$ref": "JobConfiguration", + "description": "[Full-projection-only] Specifies the job configuration." + }, + "errorResult": { + "$ref": "ErrorProto", + "description": "A result object that will be present only if the job has failed." + }, + "id": { + "description": "Unique opaque ID of the job.", + "type": "string" + }, + "jobReference": { + "$ref": "JobReference", + "description": "Job reference uniquely identifying the job." + }, + "kind": { + "default": "bigquery#job", + "description": "The resource type.", + "type": "string" + }, + "state": { + "description": "Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.", + "type": "string" + }, + "statistics": { + "$ref": "JobStatistics", + "description": "[Output-only] Information about the job, including starting time and ending time of the job." + }, + "status": { + "$ref": "JobStatus", + "description": "[Full-projection-only] Describes the state of the job." + }, + "user_email": { + "description": "[Full-projection-only] Email address of the user who ran the job.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "kind": { + "default": "bigquery#jobList", + "description": "The resource type of the response.", + "type": "string" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "JobReference": { + "id": "JobReference", + "properties": { + "jobId": { + "annotations": { + "required": [ + "bigquery.jobs.getQueryResults" + ] + }, + "description": "[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.", + "type": "string" + }, + "location": { + "description": "The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "type": "string" + }, + "projectId": { + "annotations": { + "required": [ + "bigquery.jobs.getQueryResults" + ] + }, + "description": "[Required] The ID of the project containing this job.", + "type": "string" + } + }, + "type": "object" + }, + "JobStatistics": { + "id": "JobStatistics", + "properties": { + "completionRatio": { + "description": "[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.", + "format": "double", + "type": "number" + }, + "creationTime": { + "description": "[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.", + "format": "int64", + "type": "string" + }, + "endTime": { + "description": "[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.", + "format": "int64", + "type": "string" + }, + "extract": { + "$ref": "JobStatistics4", + "description": "[Output-only] Statistics for an extract job." + }, + "load": { + "$ref": "JobStatistics3", + "description": "[Output-only] Statistics for a load job." + }, + "numChildJobs": { + "description": "[Output-only] Number of child jobs executed.", + "format": "int64", + "type": "string" + }, + "parentJobId": { + "description": "[Output-only] If this is a child job, the id of the parent.", + "type": "string" + }, + "query": { + "$ref": "JobStatistics2", + "description": "[Output-only] Statistics for a query job." + }, + "quotaDeferments": { + "description": "[Output-only] Quotas which delayed this job's start time.", + "items": { + "type": "string" + }, + "type": "array" + }, + "reservationUsage": { + "description": "[Output-only] Job resource usage breakdown by reservation.", + "items": { + "properties": { + "name": { + "description": "[Output-only] Reservation name or \"unreserved\" for on-demand resources usage.", + "type": "string" + }, + "slotMs": { + "description": "[Output-only] Slot-milliseconds the job spent in the given reservation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "reservation_id": { + "description": "[Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.", + "type": "string" + }, + "rowLevelSecurityStatistics": { + "$ref": "RowLevelSecurityStatistics", + "description": "[Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs." + }, + "scriptStatistics": { + "$ref": "ScriptStatistics", + "description": "[Output-only] Statistics for a child job of a script." + }, + "sessionInfoTemplate": { + "$ref": "SessionInfo", + "description": "[Output-only] [Preview] Information of the session if this job is part of one." + }, + "startTime": { + "description": "[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.", + "format": "int64", + "type": "string" + }, + "totalBytesProcessed": { + "description": "[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.", + "format": "int64", + "type": "string" + }, + "totalSlotMs": { + "description": "[Output-only] Slot-milliseconds for the job.", + "format": "int64", + "type": "string" + }, + "transactionInfoTemplate": { + "$ref": "TransactionInfo", + "description": "[Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one." + } + }, + "type": "object" + }, + "JobStatistics2": { + "id": "JobStatistics2", + "properties": { + "billingTier": { + "description": "[Output-only] Billing tier for the job.", + "format": "int32", + "type": "integer" + }, + "cacheHit": { + "description": "[Output-only] Whether the query result was fetched from the query cache.", + "type": "boolean" + }, + "ddlAffectedRowAccessPolicyCount": { + "description": "[Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.", + "format": "int64", + "type": "string" + }, + "ddlOperationPerformed": { + "description": "The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): \"CREATE\": The query created the DDL target. \"SKIP\": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. \"REPLACE\": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. \"DROP\": The query deleted the DDL target.", + "type": "string" + }, + "ddlTargetDataset": { + "$ref": "DatasetReference", + "description": "[Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries." + }, + "ddlTargetRoutine": { + "$ref": "RoutineReference", + "description": "The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries." + }, + "ddlTargetRowAccessPolicy": { + "$ref": "RowAccessPolicyReference", + "description": "[Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries." + }, + "ddlTargetTable": { + "$ref": "TableReference", + "description": "[Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries." + }, + "estimatedBytesProcessed": { + "description": "[Output-only] The original estimate of bytes processed for the job.", + "format": "int64", + "type": "string" + }, + "modelTraining": { + "$ref": "BigQueryModelTraining", + "description": "[Output-only, Beta] Information about create model query job progress." + }, + "modelTrainingCurrentIteration": { + "description": "[Output-only, Beta] Deprecated; do not use.", + "format": "int32", + "type": "integer" + }, + "modelTrainingExpectedTotalIteration": { + "description": "[Output-only, Beta] Deprecated; do not use.", + "format": "int64", + "type": "string" + }, + "numDmlAffectedRows": { + "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.", + "format": "int64", + "type": "string" + }, + "queryPlan": { + "description": "[Output-only] Describes execution plan for the query.", + "items": { + "$ref": "ExplainQueryStage" + }, + "type": "array" + }, + "referencedRoutines": { + "description": "[Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.", + "items": { + "$ref": "RoutineReference" + }, + "type": "array" + }, + "referencedTables": { + "description": "[Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.", + "items": { + "$ref": "TableReference" + }, + "type": "array" + }, + "reservationUsage": { + "description": "[Output-only] Job resource usage breakdown by reservation.", + "items": { + "properties": { + "name": { + "description": "[Output-only] Reservation name or \"unreserved\" for on-demand resources usage.", + "type": "string" + }, + "slotMs": { + "description": "[Output-only] Slot-milliseconds the job spent in the given reservation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "schema": { + "$ref": "TableSchema", + "description": "[Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries." + }, + "statementType": { + "description": "The type of query statement, if valid. Possible values (new values might be added in the future): \"SELECT\": SELECT query. \"INSERT\": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"UPDATE\": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"DELETE\": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"MERGE\": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"ALTER_TABLE\": ALTER TABLE query. \"ALTER_VIEW\": ALTER VIEW query. \"ASSERT\": ASSERT condition AS 'description'. \"CREATE_FUNCTION\": CREATE FUNCTION query. \"CREATE_MODEL\": CREATE [OR REPLACE] MODEL ... AS SELECT ... . \"CREATE_PROCEDURE\": CREATE PROCEDURE query. \"CREATE_TABLE\": CREATE [OR REPLACE] TABLE without AS SELECT. \"CREATE_TABLE_AS_SELECT\": CREATE [OR REPLACE] TABLE ... AS SELECT ... . \"CREATE_VIEW\": CREATE [OR REPLACE] VIEW ... AS SELECT ... . \"DROP_FUNCTION\" : DROP FUNCTION query. \"DROP_PROCEDURE\": DROP PROCEDURE query. \"DROP_TABLE\": DROP TABLE query. \"DROP_VIEW\": DROP VIEW query.", + "type": "string" + }, + "timeline": { + "description": "[Output-only] [Beta] Describes a timeline of job execution.", + "items": { + "$ref": "QueryTimelineSample" + }, + "type": "array" + }, + "totalBytesBilled": { + "description": "[Output-only] Total bytes billed for the job.", + "format": "int64", + "type": "string" + }, + "totalBytesProcessed": { + "description": "[Output-only] Total bytes processed for the job.", + "format": "int64", + "type": "string" + }, + "totalBytesProcessedAccuracy": { + "description": "[Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.", + "type": "string" + }, + "totalPartitionsProcessed": { + "description": "[Output-only] Total number of partitions processed from all partitioned tables referenced in the job.", + "format": "int64", + "type": "string" + }, + "totalSlotMs": { + "description": "[Output-only] Slot-milliseconds for the job.", + "format": "int64", + "type": "string" + }, + "undeclaredQueryParameters": { + "description": "Standard SQL only: list of undeclared query parameters detected during a dry run validation.", + "items": { + "$ref": "QueryParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "JobStatistics3": { + "id": "JobStatistics3", + "properties": { + "badRecords": { + "description": "[Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.", + "format": "int64", + "type": "string" + }, + "inputFileBytes": { + "description": "[Output-only] Number of bytes of source data in a load job.", + "format": "int64", + "type": "string" + }, + "inputFiles": { + "description": "[Output-only] Number of source files in a load job.", + "format": "int64", + "type": "string" + }, + "outputBytes": { + "description": "[Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.", + "format": "int64", + "type": "string" + }, + "outputRows": { + "description": "[Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "JobStatistics4": { + "id": "JobStatistics4", + "properties": { + "destinationUriFileCounts": { + "description": "[Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "inputBytes": { + "description": "[Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "JobStatus": { + "id": "JobStatus", + "properties": { + "errorResult": { + "$ref": "ErrorProto", + "description": "[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful." + }, + "errors": { + "description": "[Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "state": { + "description": "[Output-only] Running state of the job.", + "type": "string" + } + }, + "type": "object" + }, + "JsonObject": { + "additionalProperties": { + "$ref": "JsonValue" + }, + "description": "Represents a single JSON object.", + "id": "JsonObject", + "type": "object" + }, + "JsonValue": { + "id": "JsonValue", + "type": "any" + }, + "ListModelsResponse": { + "id": "ListModelsResponse", + "properties": { + "models": { + "description": "Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.", + "items": { + "$ref": "Model" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListRoutinesResponse": { + "id": "ListRoutinesResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "routines": { + "description": "Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.", + "items": { + "$ref": "Routine" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRowAccessPoliciesResponse": { + "description": "Response message for the ListRowAccessPolicies method.", + "id": "ListRowAccessPoliciesResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "rowAccessPolicies": { + "description": "Row access policies on the requested table.", + "items": { + "$ref": "RowAccessPolicy" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationMetadata": { + "description": "BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.", + "id": "LocationMetadata", + "properties": { + "legacyLocationId": { + "description": "The legacy BigQuery location ID, e.g. \u201cEU\u201d for the \u201ceurope\u201d location. This is for any API consumers that need the legacy \u201cUS\u201d and \u201cEU\u201d locations.", + "type": "string" + } + }, + "type": "object" + }, + "MaterializedViewDefinition": { + "id": "MaterializedViewDefinition", + "properties": { + "enableRefresh": { + "description": "[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is \"true\".", + "type": "boolean" + }, + "lastRefreshTime": { + "description": "[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "query": { + "description": "[Required] A query whose result is persisted.", + "type": "string" + }, + "refreshIntervalMs": { + "description": "[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is \"1800000\" (30 minutes).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Model": { + "id": "Model", + "properties": { + "bestTrialId": { + "description": "The best trial_id across all training runs.", + "format": "int64", + "type": "string" + }, + "creationTime": { + "description": "Output only. The time when this model was created, in millisecs since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A user-friendly description of this model.", + "type": "string" + }, + "encryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model." + }, + "etag": { + "description": "Output only. A hash of this resource.", + "readOnly": true, + "type": "string" + }, + "expirationTime": { + "description": "Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.", + "format": "int64", + "type": "string" + }, + "featureColumns": { + "description": "Output only. Input feature columns that were used to train this model.", + "items": { + "$ref": "StandardSqlField" + }, + "readOnly": true, + "type": "array" + }, + "friendlyName": { + "description": "Optional. A descriptive name for this model.", + "type": "string" + }, + "labelColumns": { + "description": "Output only. Label columns that were used to train this model. The output of the model will have a \"predicted_\" prefix to these columns.", + "items": { + "$ref": "StandardSqlField" + }, + "readOnly": true, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "lastModifiedTime": { + "description": "Output only. The time when this model was last modified, in millisecs since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Output only. The geographic location where the model resides. This value is inherited from the dataset.", + "readOnly": true, + "type": "string" + }, + "modelReference": { + "$ref": "ModelReference", + "description": "Required. Unique identifier for this model." + }, + "modelType": { + "description": "Output only. Type of the model resource.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "LINEAR_REGRESSION", + "LOGISTIC_REGRESSION", + "KMEANS", + "MATRIX_FACTORIZATION", + "DNN_CLASSIFIER", + "TENSORFLOW", + "DNN_REGRESSOR", + "BOOSTED_TREE_REGRESSOR", + "BOOSTED_TREE_CLASSIFIER", + "ARIMA", + "AUTOML_REGRESSOR", + "AUTOML_CLASSIFIER" + ], + "enumDescriptions": [ + "", + "Linear regression model.", + "Logistic regression based classification model.", + "K-means clustering model.", + "Matrix factorization model.", + "DNN classifier model.", + "An imported TensorFlow model.", + "DNN regressor model.", + "Boosted tree regressor model.", + "Boosted tree classifier model.", + "ARIMA model.", + "[Beta] AutoML Tables regression model.", + "[Beta] AutoML Tables classification model." + ], + "readOnly": true, + "type": "string" + }, + "trainingRuns": { + "description": "Output only. Information for all training runs in increasing order of start_time.", + "items": { + "$ref": "TrainingRun" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ModelDefinition": { + "id": "ModelDefinition", + "properties": { + "modelOptions": { + "description": "[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.", + "properties": { + "labels": { + "items": { + "type": "string" + }, + "type": "array" + }, + "lossType": { + "type": "string" + }, + "modelType": { + "type": "string" + } + }, + "type": "object" + }, + "trainingRuns": { + "description": "[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.", + "items": { + "$ref": "BqmlTrainingRun" + }, + "type": "array" + } + }, + "type": "object" + }, + "ModelReference": { + "id": "ModelReference", + "properties": { + "datasetId": { + "description": "[Required] The ID of the dataset containing this model.", + "type": "string" + }, + "modelId": { + "description": "[Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.", + "type": "string" + }, + "projectId": { + "description": "[Required] The ID of the project containing this model.", + "type": "string" + } + }, + "type": "object" + }, + "MultiClassClassificationMetrics": { + "description": "Evaluation metrics for multi-class classification/classifier models.", + "id": "MultiClassClassificationMetrics", + "properties": { + "aggregateClassificationMetrics": { + "$ref": "AggregateClassificationMetrics", + "description": "Aggregate classification metrics." + }, + "confusionMatrixList": { + "description": "Confusion matrix at different thresholds.", + "items": { + "$ref": "ConfusionMatrix" + }, + "type": "array" + } + }, + "type": "object" + }, + "ParquetOptions": { + "id": "ParquetOptions", + "properties": { + "enableListInference": { + "description": "[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.", + "type": "boolean" + }, + "enumAsString": { + "description": "[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.", + "type": "boolean" + } + }, + "type": "object" + }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PrincipalComponentInfo": { + "description": "Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.", + "id": "PrincipalComponentInfo", + "properties": { + "cumulativeExplainedVarianceRatio": { + "description": "The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.", + "format": "double", + "type": "number" + }, + "explainedVariance": { + "description": "Explained variance by this principal component, which is simply the eigenvalue.", + "format": "double", + "type": "number" + }, + "explainedVarianceRatio": { + "description": "Explained_variance over the total explained variance.", + "format": "double", + "type": "number" + }, + "principalComponentId": { + "description": "Id of the principal component.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ProjectList": { + "id": "ProjectList", + "properties": { + "etag": { + "description": "A hash of the page of results", + "type": "string" + }, + "kind": { + "default": "bigquery#projectList", + "description": "The type of list.", + "type": "string" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "projects": { + "description": "Projects to which you have at least READ access.", + "items": { + "properties": { + "friendlyName": { + "description": "A descriptive name for this project.", + "type": "string" + }, + "id": { + "description": "An opaque ID of this project.", + "type": "string" + }, + "kind": { + "default": "bigquery#project", + "description": "The resource type.", + "type": "string" + }, + "numericId": { + "description": "The numeric ID of this project.", + "format": "uint64", + "type": "string" + }, + "projectReference": { + "$ref": "ProjectReference", + "description": "A unique reference to this project." + } + }, + "type": "object" + }, + "type": "array" + }, + "totalItems": { + "description": "The total number of projects in the list.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ProjectReference": { + "id": "ProjectReference", + "properties": { + "projectId": { + "description": "[Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.", + "type": "string" + } + }, + "type": "object" + }, + "QueryParameter": { + "id": "QueryParameter", + "properties": { + "name": { + "description": "[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.", + "type": "string" + }, + "parameterType": { + "$ref": "QueryParameterType", + "description": "[Required] The type of this parameter." + }, + "parameterValue": { + "$ref": "QueryParameterValue", + "description": "[Required] The value of this parameter." + } + }, + "type": "object" + }, + "QueryParameterType": { + "id": "QueryParameterType", + "properties": { + "arrayType": { + "$ref": "QueryParameterType", + "description": "[Optional] The type of the array's elements, if this is an array." + }, + "structTypes": { + "description": "[Optional] The types of the fields of this struct, in order, if this is a struct.", + "items": { + "properties": { + "description": { + "description": "[Optional] Human-oriented description of the field.", + "type": "string" + }, + "name": { + "description": "[Optional] The name of this field.", + "type": "string" + }, + "type": { + "$ref": "QueryParameterType", + "description": "[Required] The type of this field." + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "[Required] The top level type of this field.", + "type": "string" + } + }, + "type": "object" + }, + "QueryParameterValue": { + "id": "QueryParameterValue", + "properties": { + "arrayValues": { + "description": "[Optional] The array values, if this is an array type.", + "items": { + "$ref": "QueryParameterValue" + }, + "type": "array" + }, + "structValues": { + "additionalProperties": { + "$ref": "QueryParameterValue" + }, + "description": "[Optional] The struct field values, in order of the struct type's declaration.", + "type": "object" + }, + "value": { + "description": "[Optional] The value of this value, if a simple scalar type.", + "type": "string" + } + }, + "type": "object" + }, + "QueryRequest": { + "id": "QueryRequest", + "properties": { + "connectionProperties": { + "description": "Connection properties.", + "items": { + "$ref": "ConnectionProperty" + }, + "type": "array" + }, + "createSession": { + "description": "If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.", + "type": "boolean" + }, + "defaultDataset": { + "$ref": "DatasetReference", + "description": "[Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'." + }, + "dryRun": { + "description": "[Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.", + "type": "boolean" + }, + "kind": { + "default": "bigquery#queryRequest", + "description": "The resource type of the request.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "location": { + "description": "The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "type": "string" + }, + "maxResults": { + "description": "[Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.", + "format": "uint32", + "type": "integer" + }, + "maximumBytesBilled": { + "description": "[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.", + "format": "int64", + "type": "string" + }, + "parameterMode": { + "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.", + "type": "string" + }, + "preserveNulls": { + "description": "[Deprecated] This property is deprecated.", + "type": "boolean" + }, + "query": { + "annotations": { + "required": [ + "bigquery.jobs.query" + ] + }, + "description": "[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: \"SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]\".", + "type": "string" + }, + "queryParameters": { + "description": "Query parameters for Standard SQL queries.", + "items": { + "$ref": "QueryParameter" + }, + "type": "array" + }, + "requestId": { + "description": "A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of the previous request, all parameters in the request that may affect the behavior are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.", + "type": "string" + }, + "timeoutMs": { + "description": "[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).", + "format": "uint32", + "type": "integer" + }, + "useLegacySql": { + "default": "true", + "description": "Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.", + "type": "boolean" + }, + "useQueryCache": { + "default": "true", + "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.", + "type": "boolean" + } + }, + "type": "object" + }, + "QueryResponse": { + "id": "QueryResponse", + "properties": { + "cacheHit": { + "description": "Whether the query result was fetched from the query cache.", + "type": "boolean" + }, + "errors": { + "description": "[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "jobComplete": { + "description": "Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.", + "type": "boolean" + }, + "jobReference": { + "$ref": "JobReference", + "description": "Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults)." + }, + "kind": { + "default": "bigquery#queryResponse", + "description": "The resource type.", + "type": "string" + }, + "numDmlAffectedRows": { + "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.", + "format": "int64", + "type": "string" + }, + "pageToken": { + "description": "A token used for paging results.", + "type": "string" + }, + "rows": { + "description": "An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.", + "items": { + "$ref": "TableRow" + }, + "type": "array" + }, + "schema": { + "$ref": "TableSchema", + "description": "The schema of the results. Present only when the query completes successfully." + }, + "sessionInfoTemplate": { + "$ref": "SessionInfo", + "description": "[Output-only] [Preview] Information of the session if this job is part of one." + }, + "totalBytesProcessed": { + "description": "The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.", + "format": "int64", + "type": "string" + }, + "totalRows": { + "description": "The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "QueryTimelineSample": { + "id": "QueryTimelineSample", + "properties": { + "activeUnits": { + "description": "Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.", + "format": "int64", + "type": "string" + }, + "completedUnits": { + "description": "Total parallel units of work completed by this query.", + "format": "int64", + "type": "string" + }, + "elapsedMs": { + "description": "Milliseconds elapsed since the start of query execution.", + "format": "int64", + "type": "string" + }, + "pendingUnits": { + "description": "Total parallel units of work remaining for the active stages.", + "format": "int64", + "type": "string" + }, + "totalSlotMs": { + "description": "Cumulative slot-ms consumed by the query.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RangePartitioning": { + "id": "RangePartitioning", + "properties": { + "field": { + "description": "[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.", + "type": "string" + }, + "range": { + "description": "[TrustedTester] [Required] Defines the ranges for range partitioning.", + "properties": { + "end": { + "description": "[TrustedTester] [Required] The end of range partitioning, exclusive.", + "format": "int64", + "type": "string" + }, + "interval": { + "description": "[TrustedTester] [Required] The width of each interval.", + "format": "int64", + "type": "string" + }, + "start": { + "description": "[TrustedTester] [Required] The start of range partitioning, inclusive.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RankingMetrics": { + "description": "Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit.", + "id": "RankingMetrics", + "properties": { + "averageRank": { + "description": "Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.", + "format": "double", + "type": "number" + }, + "meanAveragePrecision": { + "description": "Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.", + "format": "double", + "type": "number" + }, + "meanSquaredError": { + "description": "Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.", + "format": "double", + "type": "number" + }, + "normalizedDiscountedCumulativeGain": { + "description": "A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "RegressionMetrics": { + "description": "Evaluation metrics for regression and explicit feedback type matrix factorization models.", + "id": "RegressionMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean absolute error.", + "format": "double", + "type": "number" + }, + "meanSquaredError": { + "description": "Mean squared error.", + "format": "double", + "type": "number" + }, + "meanSquaredLogError": { + "description": "Mean squared log error.", + "format": "double", + "type": "number" + }, + "medianAbsoluteError": { + "description": "Median absolute error.", + "format": "double", + "type": "number" + }, + "rSquared": { + "description": "R^2 score. This corresponds to r2_score in ML.EVALUATE.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Routine": { + "description": "A user-defined function or a stored procedure.", + "id": "Routine", + "properties": { + "arguments": { + "description": "Optional.", + "items": { + "$ref": "Argument" + }, + "type": "array" + }, + "creationTime": { + "description": "Output only. The time when this routine was created, in milliseconds since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "definitionBody": { + "description": "Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, \"\\n\", y))` The definition_body is `concat(x, \"\\n\", y)` (\\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return \"\\n\";\\n'` The definition_body is `return \"\\n\";\\n` Note that both \\n are replaced with linebreaks.", + "type": "string" + }, + "description": { + "description": "Optional. [Experimental] The description of the routine if defined.", + "type": "string" + }, + "determinismLevel": { + "description": "Optional. [Experimental] The determinism level of the JavaScript UDF if defined.", + "enum": [ + "DETERMINISM_LEVEL_UNSPECIFIED", + "DETERMINISTIC", + "NOT_DETERMINISTIC" + ], + "enumDescriptions": [ + "The determinism of the UDF is unspecified.", + "The UDF is deterministic, meaning that 2 function calls with the same inputs always produce the same result, even across 2 query runs.", + "The UDF is not deterministic." + ], + "type": "string" + }, + "etag": { + "description": "Output only. A hash of this resource.", + "readOnly": true, + "type": "string" + }, + "importedLibraries": { + "description": "Optional. If language = \"JAVASCRIPT\", this field stores the path of the imported JAVASCRIPT libraries.", + "items": { + "type": "string" + }, + "type": "array" + }, + "language": { + "description": "Optional. Defaults to \"SQL\".", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "SQL", + "JAVASCRIPT" + ], + "enumDescriptions": [ + "", + "SQL language.", + "JavaScript language." + ], + "type": "string" + }, + "lastModifiedTime": { + "description": "Output only. The time when this routine was last modified, in milliseconds since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "returnTableType": { + "$ref": "StandardSqlTableType", + "description": "Optional. Set only if Routine is a \"TABLE_VALUED_FUNCTION\". TODO(b/173344646) - Update return_type documentation to say it cannot be set for TABLE_VALUED_FUNCTION before preview launch." + }, + "returnType": { + "$ref": "StandardSqlDataType", + "description": "Optional if language = \"SQL\"; required otherwise. If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: \"FLOAT64\"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64." + }, + "routineReference": { + "$ref": "RoutineReference", + "description": "Required. Reference describing the ID of this routine." + }, + "routineType": { + "description": "Required. The type of routine.", + "enum": [ + "ROUTINE_TYPE_UNSPECIFIED", + "SCALAR_FUNCTION", + "PROCEDURE", + "TABLE_VALUED_FUNCTION" + ], + "enumDescriptions": [ + "", + "Non-builtin permanent scalar function.", + "Stored procedure.", + "Non-builtin permanent TVF." + ], + "type": "string" + } + }, + "type": "object" + }, + "RoutineReference": { + "id": "RoutineReference", + "properties": { + "datasetId": { + "description": "[Required] The ID of the dataset containing this routine.", + "type": "string" + }, + "projectId": { + "description": "[Required] The ID of the project containing this routine.", + "type": "string" + }, + "routineId": { + "description": "[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "Row": { + "description": "A single row in the confusion matrix.", + "id": "Row", + "properties": { + "actualLabel": { + "description": "The original label of this row.", + "type": "string" + }, + "entries": { + "description": "Info describing predicted label distribution.", + "items": { + "$ref": "Entry" + }, + "type": "array" + } + }, + "type": "object" + }, + "RowAccessPolicy": { + "description": "Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.", + "id": "RowAccessPolicy", + "properties": { + "creationTime": { + "description": "Output only. The time when this row access policy was created, in milliseconds since the epoch.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. A hash of this resource.", + "readOnly": true, + "type": "string" + }, + "filterPredicate": { + "description": "Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0", + "type": "string" + }, + "lastModifiedTime": { + "description": "Output only. The time when this row access policy was last modified, in milliseconds since the epoch.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "rowAccessPolicyReference": { + "$ref": "RowAccessPolicyReference", + "description": "Required. Reference describing the ID of this row access policy." + } + }, + "type": "object" + }, + "RowAccessPolicyReference": { + "id": "RowAccessPolicyReference", + "properties": { + "datasetId": { + "description": "[Required] The ID of the dataset containing this row access policy.", + "type": "string" + }, + "policyId": { + "description": "[Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.", + "type": "string" + }, + "projectId": { + "description": "[Required] The ID of the project containing this row access policy.", + "type": "string" + }, + "tableId": { + "description": "[Required] The ID of the table containing this row access policy.", + "type": "string" + } + }, + "type": "object" + }, + "RowLevelSecurityStatistics": { + "id": "RowLevelSecurityStatistics", + "properties": { + "rowLevelSecurityApplied": { + "description": "[Output-only] [Preview] Whether any accessed data was protected by row access policies.", + "type": "boolean" + } + }, + "type": "object" + }, + "ScriptStackFrame": { + "id": "ScriptStackFrame", + "properties": { + "endColumn": { + "description": "[Output-only] One-based end column.", + "format": "int32", + "type": "integer" + }, + "endLine": { + "description": "[Output-only] One-based end line.", + "format": "int32", + "type": "integer" + }, + "procedureId": { + "description": "[Output-only] Name of the active procedure, empty if in a top-level script.", + "type": "string" + }, + "startColumn": { + "description": "[Output-only] One-based start column.", + "format": "int32", + "type": "integer" + }, + "startLine": { + "description": "[Output-only] One-based start line.", + "format": "int32", + "type": "integer" + }, + "text": { + "description": "[Output-only] Text of the current statement/expression.", + "type": "string" + } + }, + "type": "object" + }, + "ScriptStatistics": { + "id": "ScriptStatistics", + "properties": { + "evaluationKind": { + "description": "[Output-only] Whether this child job was a statement or expression.", + "type": "string" + }, + "stackFrames": { + "description": "Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.", + "items": { + "$ref": "ScriptStackFrame" + }, + "type": "array" + } + }, + "type": "object" + }, + "SessionInfo": { + "id": "SessionInfo", + "properties": { + "sessionId": { + "description": "[Output-only] // [Preview] Id of the session.", + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "SnapshotDefinition": { + "id": "SnapshotDefinition", + "properties": { + "baseTableReference": { + "$ref": "TableReference", + "description": "[Required] Reference describing the ID of the table that is snapshotted." + }, + "snapshotTime": { + "description": "[Required] The time at which the base table was snapshot.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "StandardSqlDataType": { + "description": "The type of a variable, e.g., a function argument. Examples: INT64: {type_kind=\"INT64\"} ARRAY: {type_kind=\"ARRAY\", array_element_type=\"STRING\"} STRUCT>: {type_kind=\"STRUCT\", struct_type={fields=[ {name=\"x\", type={type_kind=\"STRING\"}}, {name=\"y\", type={type_kind=\"ARRAY\", array_element_type=\"DATE\"}} ]}}", + "id": "StandardSqlDataType", + "properties": { + "arrayElementType": { + "$ref": "StandardSqlDataType", + "description": "The type of the array's elements, if type_kind = \"ARRAY\"." + }, + "structType": { + "$ref": "StandardSqlStructType", + "description": "The fields of this struct, in order, if type_kind = \"STRUCT\"." + }, + "typeKind": { + "description": "Required. The top level type of this field. Can be any standard SQL data type (e.g., \"INT64\", \"DATE\", \"ARRAY\").", + "enum": [ + "TYPE_KIND_UNSPECIFIED", + "INT64", + "BOOL", + "FLOAT64", + "STRING", + "BYTES", + "TIMESTAMP", + "DATE", + "TIME", + "DATETIME", + "INTERVAL", + "GEOGRAPHY", + "NUMERIC", + "BIGNUMERIC", + "ARRAY", + "STRUCT" + ], + "enumDescriptions": [ + "Invalid type.", + "Encoded as a string in decimal format.", + "Encoded as a boolean \"false\" or \"true\".", + "Encoded as a number, or string \"NaN\", \"Infinity\" or \"-Infinity\".", + "Encoded as a string value.", + "Encoded as a base64 string per RFC 4648, section 4.", + "Encoded as an RFC 3339 timestamp with mandatory \"Z\" time zone string: 1985-04-12T23:20:50.52Z", + "Encoded as RFC 3339 full-date format string: 1985-04-12", + "Encoded as RFC 3339 partial-time format string: 23:20:50.52", + "Encoded as RFC 3339 full-date \"T\" partial-time: 1985-04-12T23:20:50.52", + "Encoded as fully qualified 3 part: 0-5 15 2:30:45.6", + "Encoded as WKT", + "Encoded as a decimal string.", + "Encoded as a decimal string.", + "Encoded as a list with types matching Type.array_type.", + "Encoded as a list with fields of type Type.struct_type[i]. List is used because a JSON object cannot have duplicate field names." + ], + "type": "string" + } + }, + "type": "object" + }, + "StandardSqlField": { + "description": "A field or a column.", + "id": "StandardSqlField", + "properties": { + "name": { + "description": "Optional. The name of this field. Can be absent for struct fields.", + "type": "string" + }, + "type": { + "$ref": "StandardSqlDataType", + "description": "Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this \"type\" field)." + } + }, + "type": "object" + }, + "StandardSqlStructType": { + "id": "StandardSqlStructType", + "properties": { + "fields": { + "items": { + "$ref": "StandardSqlField" + }, + "type": "array" + } + }, + "type": "object" + }, + "StandardSqlTableType": { + "description": "A table type", + "id": "StandardSqlTableType", + "properties": { + "columns": { + "description": "The columns in this table type", + "items": { + "$ref": "StandardSqlField" + }, + "type": "array" + } + }, + "type": "object" + }, + "Streamingbuffer": { + "id": "Streamingbuffer", + "properties": { + "estimatedBytes": { + "description": "[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.", + "format": "uint64", + "type": "string" + }, + "estimatedRows": { + "description": "[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.", + "format": "uint64", + "type": "string" + }, + "oldestEntryTime": { + "description": "[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "Table": { + "id": "Table", + "properties": { + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered." + }, + "creationTime": { + "description": "[Output-only] The time when this table was created, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "[Optional] A user-friendly description of this table.", + "type": "string" + }, + "encryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "etag": { + "description": "[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.", + "type": "string" + }, + "expirationTime": { + "description": "[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.", + "format": "int64", + "type": "string" + }, + "externalDataConfiguration": { + "$ref": "ExternalDataConfiguration", + "description": "[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table." + }, + "friendlyName": { + "description": "[Optional] A descriptive name for this table.", + "type": "string" + }, + "id": { + "description": "[Output-only] An opaque ID uniquely identifying the table.", + "type": "string" + }, + "kind": { + "default": "bigquery#table", + "description": "[Output-only] The type of the resource.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "lastModifiedTime": { + "description": "[Output-only] The time when this table was last modified, in milliseconds since the epoch.", + "format": "uint64", + "type": "string" + }, + "location": { + "description": "[Output-only] The geographic location where the table resides. This value is inherited from the dataset.", + "type": "string" + }, + "materializedView": { + "$ref": "MaterializedViewDefinition", + "description": "[Optional] Materialized view definition." + }, + "model": { + "$ref": "ModelDefinition", + "description": "[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries." + }, + "numBytes": { + "description": "[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.", + "format": "int64", + "type": "string" + }, + "numLongTermBytes": { + "description": "[Output-only] The number of bytes in the table that are considered \"long-term storage\".", + "format": "int64", + "type": "string" + }, + "numPhysicalBytes": { + "description": "[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.", + "format": "int64", + "type": "string" + }, + "numRows": { + "description": "[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.", + "format": "uint64", + "type": "string" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "requirePartitionFilter": { + "default": "false", + "description": "[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.", + "type": "boolean" + }, + "schema": { + "$ref": "TableSchema", + "description": "[Optional] Describes the schema of this table." + }, + "selfLink": { + "description": "[Output-only] A URL that can be used to access this resource again.", + "type": "string" + }, + "snapshotDefinition": { + "$ref": "SnapshotDefinition", + "description": "[Output-only] Snapshot definition." + }, + "streamingBuffer": { + "$ref": "Streamingbuffer", + "description": "[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer." + }, + "tableReference": { + "$ref": "TableReference", + "description": "[Required] Reference describing the ID of this table." + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "type": { + "description": "[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.", + "type": "string" + }, + "view": { + "$ref": "ViewDefinition", + "description": "[Optional] The view definition." + } + }, + "type": "object" + }, + "TableCell": { + "id": "TableCell", + "properties": { + "v": { + "type": "any" + } + }, + "type": "object" + }, + "TableDataInsertAllRequest": { + "id": "TableDataInsertAllRequest", + "properties": { + "ignoreUnknownValues": { + "description": "[Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.", + "type": "boolean" + }, + "kind": { + "default": "bigquery#tableDataInsertAllRequest", + "description": "The resource type of the response.", + "type": "string" + }, + "rows": { + "description": "The rows to insert.", + "items": { + "properties": { + "insertId": { + "description": "[Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.", + "type": "string" + }, + "json": { + "$ref": "JsonObject", + "description": "[Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema." + } + }, + "type": "object" + }, + "type": "array" + }, + "skipInvalidRows": { + "description": "[Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.", + "type": "boolean" + }, + "templateSuffix": { + "description": "If specified, treats the destination table as a base template, and inserts the rows into an instance table named \"{destination}{templateSuffix}\". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.", + "type": "string" + } + }, + "type": "object" + }, + "TableDataInsertAllResponse": { + "id": "TableDataInsertAllResponse", + "properties": { + "insertErrors": { + "description": "An array of errors for rows that were not inserted.", + "items": { + "properties": { + "errors": { + "description": "Error information for the row indicated by the index property.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "index": { + "description": "The index of the row that error applies to.", + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "kind": { + "default": "bigquery#tableDataInsertAllResponse", + "description": "The resource type of the response.", + "type": "string" + } + }, + "type": "object" + }, + "TableDataList": { + "id": "TableDataList", + "properties": { + "etag": { + "description": "A hash of this page of results.", + "type": "string" + }, + "kind": { + "default": "bigquery#tableDataList", + "description": "The resource type of the response.", + "type": "string" + }, + "pageToken": { + "description": "A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.", + "type": "string" + }, + "rows": { + "description": "Rows of results.", + "items": { + "$ref": "TableRow" + }, + "type": "array" + }, + "totalRows": { + "description": "The total number of rows in the complete table.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "TableFieldSchema": { + "id": "TableFieldSchema", + "properties": { + "categories": { + "description": "[Optional] The categories attached to this field, used for field-level access control.", + "properties": { + "names": { + "description": "A list of category resource names. For example, \"projects/1/taxonomies/2/categories/3\". At most 5 categories are allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "description": { + "description": "[Optional] The field description. The maximum length is 1,024 characters.", + "type": "string" + }, + "fields": { + "description": "[Optional] Describes the nested schema fields if the type property is set to RECORD.", + "items": { + "$ref": "TableFieldSchema" + }, + "type": "array" + }, + "maxLength": { + "description": "[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = \"STRING\", then max_length represents the maximum UTF-8 length of strings in this field. If type = \"BYTES\", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type \u2260 \"STRING\" and \u2260 \"BYTES\".", + "format": "int64", + "type": "string" + }, + "mode": { + "description": "[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.", + "type": "string" + }, + "name": { + "description": "[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.", + "type": "string" + }, + "policyTags": { + "properties": { + "names": { + "description": "A list of category resource names. For example, \"projects/1/location/eu/taxonomies/2/policyTags/3\". At most 1 policy tag is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "precision": { + "description": "[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type \u2260 \"NUMERIC\" and \u2260 \"BIGNUMERIC\". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = \"NUMERIC\": 1 \u2264 precision - scale \u2264 29 and 0 \u2264 scale \u2264 9. - If type = \"BIGNUMERIC\": 1 \u2264 precision - scale \u2264 38 and 0 \u2264 scale \u2264 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = \"NUMERIC\": 1 \u2264 precision \u2264 29. - If type = \"BIGNUMERIC\": 1 \u2264 precision \u2264 38. If scale is specified but not precision, then it is invalid.", + "format": "int64", + "type": "string" + }, + "scale": { + "description": "[Optional] See documentation for precision.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).", + "type": "string" + } + }, + "type": "object" + }, + "TableList": { + "id": "TableList", + "properties": { + "etag": { + "description": "A hash of this page of results.", + "type": "string" + }, + "kind": { + "default": "bigquery#tableList", + "description": "The type of list.", + "type": "string" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "tables": { + "description": "Tables in the requested dataset.", + "items": { + "properties": { + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for this table, if configured." + }, + "creationTime": { + "description": "The time when this table was created, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "expirationTime": { + "description": "[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.", + "format": "int64", + "type": "string" + }, + "friendlyName": { + "description": "The user-friendly name for this table.", + "type": "string" + }, + "id": { + "description": "An opaque ID of the table", + "type": "string" + }, + "kind": { + "default": "bigquery#table", + "description": "The resource type.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this table. You can use these to organize and group your tables.", + "type": "object" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "The range partitioning specification for this table, if configured." + }, + "tableReference": { + "$ref": "TableReference", + "description": "A reference uniquely identifying the table." + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "The time-based partitioning specification for this table, if configured." + }, + "type": { + "description": "The type of table. Possible values are: TABLE, VIEW.", + "type": "string" + }, + "view": { + "description": "Additional details for a view.", + "properties": { + "useLegacySql": { + "description": "True if view is defined in legacy SQL dialect, false if in standard SQL.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + }, + "totalItems": { + "description": "The total number of tables in the dataset.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TableReference": { + "id": "TableReference", + "properties": { + "datasetId": { + "annotations": { + "required": [ + "bigquery.tables.update" + ] + }, + "description": "[Required] The ID of the dataset containing this table.", + "type": "string" + }, + "projectId": { + "annotations": { + "required": [ + "bigquery.tables.update" + ] + }, + "description": "[Required] The ID of the project containing this table.", + "type": "string" + }, + "tableId": { + "annotations": { + "required": [ + "bigquery.tables.update" + ] + }, + "description": "[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "TableRow": { + "id": "TableRow", + "properties": { + "f": { + "description": "Represents a single row in the result set, consisting of one or more fields.", + "items": { + "$ref": "TableCell" + }, + "type": "array" + } + }, + "type": "object" + }, + "TableSchema": { + "id": "TableSchema", + "properties": { + "fields": { + "description": "Describes the fields in a table.", + "items": { + "$ref": "TableFieldSchema" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TimePartitioning": { + "id": "TimePartitioning", + "properties": { + "expirationMs": { + "description": "[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.", + "format": "int64", + "type": "string" + }, + "field": { + "description": "[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.", + "type": "string" + }, + "requirePartitionFilter": { + "type": "boolean" + }, + "type": { + "description": "[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.", + "type": "string" + } + }, + "type": "object" + }, + "TrainingOptions": { + "description": "Options used in model training.", + "id": "TrainingOptions", + "properties": { + "autoArima": { + "description": "Whether to enable auto ARIMA or not.", + "type": "boolean" + }, + "autoArimaMaxOrder": { + "description": "The max value of non-seasonal p and q.", + "format": "int64", + "type": "string" + }, + "batchSize": { + "description": "Batch size for dnn models.", + "format": "int64", + "type": "string" + }, + "dataFrequency": { + "description": "The data frequency of a time series.", + "enum": [ + "DATA_FREQUENCY_UNSPECIFIED", + "AUTO_FREQUENCY", + "YEARLY", + "QUARTERLY", + "MONTHLY", + "WEEKLY", + "DAILY", + "HOURLY", + "PER_MINUTE" + ], + "enumDescriptions": [ + "", + "Automatically inferred from timestamps.", + "Yearly data.", + "Quarterly data.", + "Monthly data.", + "Weekly data.", + "Daily data.", + "Hourly data.", + "Per-minute data." + ], + "type": "string" + }, + "dataSplitColumn": { + "description": "The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties", + "type": "string" + }, + "dataSplitEvalFraction": { + "description": "The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.", + "format": "double", + "type": "number" + }, + "dataSplitMethod": { + "description": "The data split type for training and evaluation, e.g. RANDOM.", + "enum": [ + "DATA_SPLIT_METHOD_UNSPECIFIED", + "RANDOM", + "CUSTOM", + "SEQUENTIAL", + "NO_SPLIT", + "AUTO_SPLIT" + ], + "enumDescriptions": [ + "", + "Splits data randomly.", + "Splits data with the user provided tags.", + "Splits data sequentially.", + "Data split will be skipped.", + "Splits data automatically: Uses NO_SPLIT if the data size is small. Otherwise uses RANDOM." + ], + "type": "string" + }, + "distanceType": { + "description": "Distance type for clustering models.", + "enum": [ + "DISTANCE_TYPE_UNSPECIFIED", + "EUCLIDEAN", + "COSINE" + ], + "enumDescriptions": [ + "", + "Eculidean distance.", + "Cosine distance." + ], + "type": "string" + }, + "dropout": { + "description": "Dropout probability for dnn models.", + "format": "double", + "type": "number" + }, + "earlyStop": { + "description": "Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.", + "type": "boolean" + }, + "feedbackType": { + "description": "Feedback type that specifies which algorithm to run for matrix factorization.", + "enum": [ + "FEEDBACK_TYPE_UNSPECIFIED", + "IMPLICIT", + "EXPLICIT" + ], + "enumDescriptions": [ + "", + "Use weighted-als for implicit feedback problems.", + "Use nonweighted-als for explicit feedback problems." + ], + "type": "string" + }, + "hiddenUnits": { + "description": "Hidden units for dnn models.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "holidayRegion": { + "description": "The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.", + "enum": [ + "HOLIDAY_REGION_UNSPECIFIED", + "GLOBAL", + "NA", + "JAPAC", + "EMEA", + "LAC", + "AE", + "AR", + "AT", + "AU", + "BE", + "BR", + "CA", + "CH", + "CL", + "CN", + "CO", + "CS", + "CZ", + "DE", + "DK", + "DZ", + "EC", + "EE", + "EG", + "ES", + "FI", + "FR", + "GB", + "GR", + "HK", + "HU", + "ID", + "IE", + "IL", + "IN", + "IR", + "IT", + "JP", + "KR", + "LV", + "MA", + "MX", + "MY", + "NG", + "NL", + "NO", + "NZ", + "PE", + "PH", + "PK", + "PL", + "PT", + "RO", + "RS", + "RU", + "SA", + "SE", + "SG", + "SI", + "SK", + "TH", + "TR", + "TW", + "UA", + "US", + "VE", + "VN", + "ZA" + ], + "enumDescriptions": [ + "Holiday region unspecified.", + "Global.", + "North America.", + "Japan and Asia Pacific: Korea, Greater China, India, Australia, and New Zealand.", + "Europe, the Middle East and Africa.", + "Latin America and the Caribbean.", + "United Arab Emirates", + "Argentina", + "Austria", + "Australia", + "Belgium", + "Brazil", + "Canada", + "Switzerland", + "Chile", + "China", + "Colombia", + "Czechoslovakia", + "Czech Republic", + "Germany", + "Denmark", + "Algeria", + "Ecuador", + "Estonia", + "Egypt", + "Spain", + "Finland", + "France", + "Great Britain (United Kingdom)", + "Greece", + "Hong Kong", + "Hungary", + "Indonesia", + "Ireland", + "Israel", + "India", + "Iran", + "Italy", + "Japan", + "Korea (South)", + "Latvia", + "Morocco", + "Mexico", + "Malaysia", + "Nigeria", + "Netherlands", + "Norway", + "New Zealand", + "Peru", + "Philippines", + "Pakistan", + "Poland", + "Portugal", + "Romania", + "Serbia", + "Russian Federation", + "Saudi Arabia", + "Sweden", + "Singapore", + "Slovenia", + "Slovakia", + "Thailand", + "Turkey", + "Taiwan", + "Ukraine", + "United States", + "Venezuela", + "Viet Nam", + "South Africa" + ], + "type": "string" + }, + "horizon": { + "description": "The number of periods ahead that need to be forecasted.", + "format": "int64", + "type": "string" + }, + "includeDrift": { + "description": "Include drift when fitting an ARIMA model.", + "type": "boolean" + }, + "initialLearnRate": { + "description": "Specifies the initial learning rate for the line search learn rate strategy.", + "format": "double", + "type": "number" + }, + "inputLabelColumns": { + "description": "Name of input label columns in training data.", + "items": { + "type": "string" + }, + "type": "array" + }, + "itemColumn": { + "description": "Item column specified for matrix factorization models.", + "type": "string" + }, + "kmeansInitializationColumn": { + "description": "The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.", + "type": "string" + }, + "kmeansInitializationMethod": { + "description": "The method used to initialize the centroids for kmeans algorithm.", + "enum": [ + "KMEANS_INITIALIZATION_METHOD_UNSPECIFIED", + "RANDOM", + "CUSTOM", + "KMEANS_PLUS_PLUS" + ], + "enumDescriptions": [ + "Unspecified initialization method.", + "Initializes the centroids randomly.", + "Initializes the centroids using data specified in kmeans_initialization_column.", + "Initializes with kmeans++." + ], + "type": "string" + }, + "l1Regularization": { + "description": "L1 regularization coefficient.", + "format": "double", + "type": "number" + }, + "l2Regularization": { + "description": "L2 regularization coefficient.", + "format": "double", + "type": "number" + }, + "labelClassWeights": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.", + "type": "object" + }, + "learnRate": { + "description": "Learning rate in training. Used only for iterative training algorithms.", + "format": "double", + "type": "number" + }, + "learnRateStrategy": { + "description": "The strategy to determine learn rate for the current iteration.", + "enum": [ + "LEARN_RATE_STRATEGY_UNSPECIFIED", + "LINE_SEARCH", + "CONSTANT" + ], + "enumDescriptions": [ + "", + "Use line search to determine learning rate.", + "Use a constant learning rate." + ], + "type": "string" + }, + "lossType": { + "description": "Type of loss function used during training run.", + "enum": [ + "LOSS_TYPE_UNSPECIFIED", + "MEAN_SQUARED_LOSS", + "MEAN_LOG_LOSS" + ], + "enumDescriptions": [ + "", + "Mean squared loss, used for linear regression.", + "Mean log loss, used for logistic regression." + ], + "type": "string" + }, + "maxIterations": { + "description": "The maximum number of iterations in training. Used only for iterative training algorithms.", + "format": "int64", + "type": "string" + }, + "maxTreeDepth": { + "description": "Maximum depth of a tree for boosted tree models.", + "format": "int64", + "type": "string" + }, + "minRelativeProgress": { + "description": "When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.", + "format": "double", + "type": "number" + }, + "minSplitLoss": { + "description": "Minimum split loss for boosted tree models.", + "format": "double", + "type": "number" + }, + "modelUri": { + "description": "Google Cloud Storage URI from which the model was imported. Only applicable for imported models.", + "type": "string" + }, + "nonSeasonalOrder": { + "$ref": "ArimaOrder", + "description": "A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order." + }, + "numClusters": { + "description": "Number of clusters for clustering models.", + "format": "int64", + "type": "string" + }, + "numFactors": { + "description": "Num factors specified for matrix factorization models.", + "format": "int64", + "type": "string" + }, + "optimizationStrategy": { + "description": "Optimization strategy for training linear regression models.", + "enum": [ + "OPTIMIZATION_STRATEGY_UNSPECIFIED", + "BATCH_GRADIENT_DESCENT", + "NORMAL_EQUATION" + ], + "enumDescriptions": [ + "", + "Uses an iterative batch gradient descent algorithm.", + "Uses a normal equation to solve linear regression problem." + ], + "type": "string" + }, + "preserveInputStructs": { + "description": "Whether to preserve the input structs in output feature names. Suppose there is a struct A with field b. When false (default), the output feature name is A_b. When true, the output feature name is A.b.", + "type": "boolean" + }, + "subsample": { + "description": "Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.", + "format": "double", + "type": "number" + }, + "timeSeriesDataColumn": { + "description": "Column to be designated as time series data for ARIMA model.", + "type": "string" + }, + "timeSeriesIdColumn": { + "description": "The time series id column that was used during ARIMA model training.", + "type": "string" + }, + "timeSeriesTimestampColumn": { + "description": "Column to be designated as time series timestamp for ARIMA model.", + "type": "string" + }, + "userColumn": { + "description": "User column specified for matrix factorization models.", + "type": "string" + }, + "walsAlpha": { + "description": "Hyperparameter for matrix factoration when implicit feedback type is specified.", + "format": "double", + "type": "number" + }, + "warmStart": { + "description": "Whether to train a model from the last checkpoint.", + "type": "boolean" + } + }, + "type": "object" + }, + "TrainingRun": { + "description": "Information about a single training query run for the model.", + "id": "TrainingRun", + "properties": { + "dataSplitResult": { + "$ref": "DataSplitResult", + "description": "Data split result of the training run. Only set when the input data is actually split." + }, + "evaluationMetrics": { + "$ref": "EvaluationMetrics", + "description": "The evaluation metrics over training/eval data that were computed at the end of training." + }, + "globalExplanations": { + "description": "Global explanations for important features of the model. For multi-class models, there is one entry for each label class. For other models, there is only one entry in the list.", + "items": { + "$ref": "GlobalExplanation" + }, + "type": "array" + }, + "results": { + "description": "Output of each iteration run, results.size() <= max_iterations.", + "items": { + "$ref": "IterationResult" + }, + "type": "array" + }, + "startTime": { + "description": "The start time of this training run.", + "format": "google-datetime", + "type": "string" + }, + "trainingOptions": { + "$ref": "TrainingOptions", + "description": "Options that were used for this training run, includes user specified and default options that were used." + } + }, + "type": "object" + }, + "TransactionInfo": { + "id": "TransactionInfo", + "properties": { + "transactionId": { + "description": "[Output-only] // [Alpha] Id of the transaction.", + "type": "string" + } + }, + "type": "object" + }, + "UserDefinedFunctionResource": { + "description": "This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions", + "id": "UserDefinedFunctionResource", + "properties": { + "inlineCode": { + "description": "[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.", + "type": "string" + }, + "resourceUri": { + "description": "[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).", + "type": "string" + } + }, + "type": "object" + }, + "ViewDefinition": { + "id": "ViewDefinition", + "properties": { + "query": { + "description": "[Required] A query that BigQuery executes when the view is referenced.", + "type": "string" + }, + "useLegacySql": { + "description": "Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.", + "type": "boolean" + }, + "userDefinedFunctionResources": { + "description": "Describes user-defined function resources used in the query.", + "items": { + "$ref": "UserDefinedFunctionResource" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "bigquery/v2/", + "title": "BigQuery API", + "version": "v2" +} diff --git a/scripts/test_resources/current_artifacts_dir/cloudtasks.v2.json b/scripts/test_resources/current_artifacts_dir/cloudtasks.v2.json new file mode 100644 index 00000000000..9c8d039944a --- /dev/null +++ b/scripts/test_resources/current_artifacts_dir/cloudtasks.v2.json @@ -0,0 +1,1377 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://cloudtasks.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Tasks", + "description": "Manages the execution of large numbers of distributed requests.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/tasks/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "cloudtasks:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudtasks.mtls.googleapis.com/", + "name": "cloudtasks", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "cloudtasks.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v2/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "cloudtasks.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service will select a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "queues": { + "methods": { + "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": "v2/projects/{projectsId}/locations/{locationsId}/queues", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location name in which the queue will be created. For example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/queues", + "request": { + "$ref": "Queue" + }, + "response": { + "$ref": "Queue" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. 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": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", + "httpMethod": "DELETE", + "id": "cloudtasks.projects.locations.queues.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a queue.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", + "httpMethod": "GET", + "id": "cloudtasks.projects.locations.queues.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the queue. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Queue" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy`", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists queues. Queues are returned in lexicographical order.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues", + "httpMethod": "GET", + "id": "cloudtasks.projects.locations.queues.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "`filter` can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as described in [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters). Sample filter \"state: PAUSED\". Note that using filters might cause fewer queues than the requested page_size to be returned.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/queues", + "response": { + "$ref": "ListQueuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. 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": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", + "httpMethod": "PATCH", + "id": "cloudtasks.projects.locations.queues.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "Queue" + }, + "response": { + "$ref": "Queue" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pause": { + "description": "Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:pause", + "request": { + "$ref": "PauseQueueRequest" + }, + "response": { + "$ref": "Queue" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purge": { + "description": "Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.purge", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:purge", + "request": { + "$ref": "PurgeQueueRequest" + }, + "response": { + "$ref": "Queue" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:resume", + "request": { + "$ref": "ResumeQueueRequest" + }, + "response": { + "$ref": "Queue" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy`", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on 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.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "tasks": { + "methods": { + "create": { + "description": "Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.tasks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "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": "v2/{+parent}/tasks", + "request": { + "$ref": "CreateTaskRequest" + }, + "response": { + "$ref": "Task" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}", + "httpMethod": "DELETE", + "id": "cloudtasks.projects.locations.queues.tasks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a task.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}", + "httpMethod": "GET", + "id": "cloudtasks.projects.locations.queues.tasks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "responseView": { + "description": "The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.", + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.", + "All information is returned. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Queue resource." + ], + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Task" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks", + "httpMethod": "GET", + "id": "cloudtasks.projects.locations.queues.tasks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + }, + "responseView": { + "description": "The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.", + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.", + "All information is returned. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Queue resource." + ], + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/tasks", + "response": { + "$ref": "ListTasksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "run": { + "description": "Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.tasks.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:run", + "request": { + "$ref": "RunTaskRequest" + }, + "response": { + "$ref": "Task" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20210315", + "rootUrl": "https://cloudtasks.googleapis.com/", + "schemas": { + "AppEngineHttpRequest": { + "description": "App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.", + "id": "AppEngineHttpRequest", + "properties": { + "appEngineRouting": { + "$ref": "AppEngineRouting", + "description": "Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing." + }, + "body": { + "description": "HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a 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 the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `\"AppEngine-Google; (+http://code.google.com/appengine)\"`. This header can be modified, but Cloud Tasks will append `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `\"application/octet-stream\"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `\"application/json\"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.", + "type": "object" + }, + "httpMethod": { + "description": "The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).", + "enum": [ + "HTTP_METHOD_UNSPECIFIED", + "POST", + "GET", + "HEAD", + "PUT", + "DELETE", + "PATCH", + "OPTIONS" + ], + "enumDescriptions": [ + "HTTP method unspecified", + "HTTP POST", + "HTTP GET", + "HTTP HEAD", + "HTTP PUT", + "HTTP DELETE", + "HTTP PATCH", + "HTTP OPTIONS" + ], + "type": "string" + }, + "relativeUri": { + "description": "The relative URI. The relative URI must begin with \"/\" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path \"/\" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.", + "type": "string" + } + }, + "type": "object" + }, + "AppEngineRouting": { + "description": "App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). Using AppEngineRouting requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform`", + "id": "AppEngineRouting", + "properties": { + "host": { + "description": "Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).", + "type": "string" + }, + "instance": { + "description": "App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).", + "type": "string" + }, + "service": { + "description": "App service. By default, the task is sent to the service which is the default service 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.", + "type": "string" + }, + "version": { + "description": "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.", + "type": "string" + } + }, + "type": "object" + }, + "Attempt": { + "description": "The status of a task attempt.", + "id": "Attempt", + "properties": { + "dispatchTime": { + "description": "Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + }, + "responseStatus": { + "$ref": "Status", + "description": "Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless." + }, + "responseTime": { + "description": "Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + }, + "scheduleTime": { + "description": "Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "CreateTaskRequest": { + "description": "Request message for CreateTask.", + "id": "CreateTaskRequest", + "properties": { + "responseView": { + "description": "The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.", + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.", + "All information is returned. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Queue resource." + ], + "type": "string" + }, + "task": { + "$ref": "Task", + "description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently." + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "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" + }, + "GetIamPolicyRequest": { + "description": "Request message for `GetIamPolicy` method.", + "id": "GetIamPolicyRequest", + "properties": { + "options": { + "$ref": "GetPolicyOptions", + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." + } + }, + "type": "object" + }, + "GetPolicyOptions": { + "description": "Encapsulates settings provided to GetIamPolicy.", + "id": "GetPolicyOptions", + "properties": { + "requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "HttpRequest": { + "description": "HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).", + "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 the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * X-Google-*: Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.", + "type": "object" + }, + "httpMethod": { + "description": "The HTTP method to use for the request. The default is POST.", + "enum": [ + "HTTP_METHOD_UNSPECIFIED", + "POST", + "GET", + "HEAD", + "PUT", + "DELETE", + "PATCH", + "OPTIONS" + ], + "enumDescriptions": [ + "HTTP method unspecified", + "HTTP POST", + "HTTP GET", + "HTTP HEAD", + "HTTP PUT", + "HTTP DELETE", + "HTTP PATCH", + "HTTP OPTIONS" + ], + "type": "string" + }, + "oauthToken": { + "$ref": "OAuthToken", + "description": "If specified, an [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" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListQueuesResponse": { + "description": "Response message for ListQueues.", + "id": "ListQueuesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours.", + "type": "string" + }, + "queues": { + "description": "The list of queues.", + "items": { + "$ref": "Queue" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListTasksResponse": { + "description": "Response message for listing tasks using ListTasks.", + "id": "ListTasksResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results.", + "type": "string" + }, + "tasks": { + "description": "The list of tasks.", + "items": { + "$ref": "Task" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "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", + "properties": {}, + "type": "object" + }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "bindings": { + "description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PurgeQueueRequest": { + "description": "Request message for PurgeQueue.", + "id": "PurgeQueueRequest", + "properties": {}, + "type": "object" + }, + "Queue": { + "description": "A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others.", + "id": "Queue", + "properties": { + "appEngineRoutingOverride": { + "$ref": "AppEngineRouting", + "description": "Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected. If set, `app_engine_routing_override` is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing." + }, + "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" + }, + "purgeTime": { + "description": "Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.", + "format": "google-datetime", + "type": "string" + }, + "rateLimits": { + "$ref": "RateLimits", + "description": "Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes." + }, + "retryConfig": { + "$ref": "RetryConfig", + "description": "Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks)." + }, + "stackdriverLoggingConfig": { + "$ref": "StackdriverLoggingConfig", + "description": "Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written." + }, + "state": { + "description": "Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "PAUSED", + "DISABLED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The queue is running. Tasks can be dispatched. If the queue was created using Cloud Tasks and the queue has had no activity (method calls or task dispatches) for 30 days, the queue may take a few minutes to re-activate. Some method calls may return NOT_FOUND and tasks may not be dispatched for a few minutes until the queue has been re-activated.", + "Tasks are paused by the user. If the queue is paused then Cloud Tasks will stop delivering tasks from it, but more tasks can still be added to it by the user.", + "The queue is disabled. A queue becomes `DISABLED` when [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) or [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) is uploaded which does not contain the queue. You cannot directly disable a queue. When a queue is disabled, tasks can still be added to a queue but the tasks are not dispatched. To permanently delete this queue and all of its tasks, call DeleteQueue." + ], + "type": "string" + } + }, + "type": "object" + }, + "RateLimits": { + "description": "Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.", + "id": "RateLimits", + "properties": { + "maxBurstSize": { + "description": "Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. ", + "format": "int32", + "type": "integer" + }, + "maxConcurrentDispatches": { + "description": "The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).", + "format": "int32", + "type": "integer" + }, + "maxDispatchesPerSecond": { + "description": "The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ResumeQueueRequest": { + "description": "Request message for ResumeQueue.", + "id": "ResumeQueueRequest", + "properties": {}, + "type": "object" + }, + "RetryConfig": { + "description": "Retry config. These settings determine when a failed task attempt is retried.", + "id": "RetryConfig", + "properties": { + "maxAttempts": { + "description": "Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", + "format": "int32", + "type": "integer" + }, + "maxBackoff": { + "description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", + "format": "google-duration", + "type": "string" + }, + "maxDoublings": { + "description": "The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", + "format": "int32", + "type": "integer" + }, + "maxRetryDuration": { + "description": "If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", + "format": "google-duration", + "type": "string" + }, + "minBackoff": { + "description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "RunTaskRequest": { + "description": "Request message for forcing a task to run now using RunTask.", + "id": "RunTaskRequest", + "properties": { + "responseView": { + "description": "The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.", + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.", + "All information is returned. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Queue resource." + ], + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." + } + }, + "type": "object" + }, + "StackdriverLoggingConfig": { + "description": "Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).", + "id": "StackdriverLoggingConfig", + "properties": { + "samplingRatio": { + "description": "Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "Task": { + "description": "A unit of scheduled work.", + "id": "Task", + "properties": { + "appEngineHttpRequest": { + "$ref": "AppEngineHttpRequest", + "description": "HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set." + }, + "createTime": { + "description": "Output only. The time that the task was created. `create_time` will be truncated to the nearest second.", + "format": "google-datetime", + "type": "string" + }, + "dispatchCount": { + "description": "Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.", + "format": "int32", + "type": "integer" + }, + "dispatchDeadline": { + "description": "The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline.", + "format": "google-duration", + "type": "string" + }, + "firstAttempt": { + "$ref": "Attempt", + "description": "Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks." + }, + "httpRequest": { + "$ref": "HttpRequest", + "description": "HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set." + }, + "lastAttempt": { + "$ref": "Attempt", + "description": "Output only. The status of the task's last attempt." + }, + "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" + }, + "responseCount": { + "description": "Output only. The number of attempts which have received a response.", + "format": "int32", + "type": "integer" + }, + "scheduleTime": { + "description": "The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + }, + "view": { + "description": "Output only. The view specifies which subset of the Task has been returned.", + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.", + "All information is returned. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Queue resource." + ], + "type": "string" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Tasks API", + "version": "v2", + "version_module": true +} \ No newline at end of file diff --git a/scripts/test_resources/new_artifacts_dir/bigquery.v2.json b/scripts/test_resources/new_artifacts_dir/bigquery.v2.json new file mode 100644 index 00000000000..e965bbc4422 --- /dev/null +++ b/scripts/test_resources/new_artifacts_dir/bigquery.v2.json @@ -0,0 +1,6549 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/bigquery": { + "description": "View and manage your data in Google BigQuery" + }, + "https://www.googleapis.com/auth/bigquery.insertdata": { + "description": "Insert data into Google BigQuery" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud Platform data" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/devstorage.full_control": { + "description": "Manage your data and permissions in Google Cloud Storage" + }, + "https://www.googleapis.com/auth/devstorage.read_only": { + "description": "View your data in Google Cloud Storage" + }, + "https://www.googleapis.com/auth/devstorage.read_write": { + "description": "Manage your data in Google Cloud Storage" + } + } + } + }, + "basePath": "/bigquery/v2/", + "baseUrl": "https://bigquery.googleapis.com/bigquery/v2/", + "batchPath": "batch/bigquery/v2", + "description": "A data platform for customers to create, manage, share and query data.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/bigquery/", + "icons": { + "x16": "https://www.google.com/images/icons/product/search-16.gif", + "x32": "https://www.google.com/images/icons/product/search-32.gif" + }, + "id": "bigquery:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://bigquery.mtls.googleapis.com/", + "name": "bigquery", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "alt": { + "default": "json", + "description": "Data format for the response.", + "enum": [ + "json" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json" + ], + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "userIp": { + "description": "Deprecated. Please use quotaUser instead.", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "datasets": { + "methods": { + "delete": { + "description": "Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.", + "httpMethod": "DELETE", + "id": "bigquery.datasets.delete", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of dataset being deleted", + "location": "path", + "required": true, + "type": "string" + }, + "deleteContents": { + "description": "If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False", + "location": "query", + "type": "boolean" + }, + "projectId": { + "description": "Project ID of the dataset being deleted", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the dataset specified by datasetID.", + "httpMethod": "GET", + "id": "bigquery.datasets.get", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the requested dataset", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the requested dataset", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Creates a new empty dataset.", + "httpMethod": "POST", + "id": "bigquery.datasets.insert", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID of the new dataset", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets", + "request": { + "$ref": "Dataset" + }, + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all datasets in the specified project to which you have been granted the READER dataset role.", + "httpMethod": "GET", + "id": "bigquery.datasets.list", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "all": { + "description": "Whether to list all datasets, including hidden ones", + "location": "query", + "type": "boolean" + }, + "filter": { + "description": "An expression for filtering the results of the request by label. The syntax is \"labels.[:]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See Filtering datasets using labels for details.", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "The maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the datasets to be listed", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets", + "response": { + "$ref": "DatasetList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.", + "httpMethod": "PATCH", + "id": "bigquery.datasets.patch", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "request": { + "$ref": "Dataset" + }, + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.", + "httpMethod": "PUT", + "id": "bigquery.datasets.update", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the dataset being updated", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}", + "request": { + "$ref": "Dataset" + }, + "response": { + "$ref": "Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "jobs": { + "methods": { + "cancel": { + "description": "Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.", + "httpMethod": "POST", + "id": "bigquery.jobs.cancel", + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "jobId": { + "description": "[Required] Job ID of the job to cancel", + "location": "path", + "required": true, + "type": "string" + }, + "location": { + "description": "The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "[Required] Project ID of the job to cancel", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs/{jobId}/cancel", + "response": { + "$ref": "JobCancelResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Requests that a job is deleted. This call will return when the job is deleted. This method is available in limited preview.", + "flatPath": "projects/{projectsId}/jobs/{jobsId}/delete", + "httpMethod": "DELETE", + "id": "bigquery.jobs.delete", + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "jobId": { + "description": "Required. Job ID of the job to be deleted. If this is a parent job which has child jobs, all child jobs will be deleted as well. Deletion of child jobs directly is not allowed.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "location": { + "description": "The geographic location of the job. Required. See details at: https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the job to be deleted.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/jobs/{+jobId}/delete", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.", + "httpMethod": "GET", + "id": "bigquery.jobs.get", + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "jobId": { + "description": "[Required] Job ID of the requested job", + "location": "path", + "required": true, + "type": "string" + }, + "location": { + "description": "The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "[Required] Project ID of the requested job", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs/{jobId}", + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "getQueryResults": { + "description": "Retrieves the results of a query job.", + "httpMethod": "GET", + "id": "bigquery.jobs.getQueryResults", + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "jobId": { + "description": "[Required] Job ID of the query job", + "location": "path", + "required": true, + "type": "string" + }, + "location": { + "description": "The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to read", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "[Required] Project ID of the query job", + "location": "path", + "required": true, + "type": "string" + }, + "startIndex": { + "description": "Zero-based index of the starting row", + "format": "uint64", + "location": "query", + "type": "string" + }, + "timeoutMs": { + "description": "How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false", + "format": "uint32", + "location": "query", + "type": "integer" + } + }, + "path": "projects/{projectId}/queries/{jobId}", + "response": { + "$ref": "GetQueryResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Starts a new asynchronous job. Requires the Can View project role.", + "httpMethod": "POST", + "id": "bigquery.jobs.insert", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "resumable": { + "multipart": true, + "path": "/resumable/upload/bigquery/v2/projects/{projectId}/jobs" + }, + "simple": { + "multipart": true, + "path": "/upload/bigquery/v2/projects/{projectId}/jobs" + } + } + }, + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID of the project that will be billed for the job", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_only", + "https://www.googleapis.com/auth/devstorage.read_write" + ], + "supportsMediaUpload": true + }, + "list": { + "description": "Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.", + "httpMethod": "GET", + "id": "bigquery.jobs.list", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "allUsers": { + "description": "Whether to display jobs owned by all users in the project. Default false", + "location": "query", + "type": "boolean" + }, + "maxCreationTime": { + "description": "Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned", + "format": "uint64", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "minCreationTime": { + "description": "Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned", + "format": "uint64", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "parentJobId": { + "description": "If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the jobs to list", + "location": "path", + "required": true, + "type": "string" + }, + "projection": { + "description": "Restrict information returned to a set of selected fields", + "enum": [ + "full", + "minimal" + ], + "enumDescriptions": [ + "Includes all job data", + "Does not include the job configuration" + ], + "location": "query", + "type": "string" + }, + "stateFilter": { + "description": "Filter for job state", + "enum": [ + "done", + "pending", + "running" + ], + "enumDescriptions": [ + "Finished jobs", + "Pending jobs", + "Running jobs" + ], + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "projects/{projectId}/jobs", + "response": { + "$ref": "JobList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "query": { + "description": "Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.", + "httpMethod": "POST", + "id": "bigquery.jobs.query", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID of the project billed for the query", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/queries", + "request": { + "$ref": "QueryRequest" + }, + "response": { + "$ref": "QueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "models": { + "methods": { + "delete": { + "description": "Deletes the model specified by modelId from the dataset.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models/{modelsId}", + "httpMethod": "DELETE", + "id": "bigquery.models.delete", + "parameterOrder": [ + "projectId", + "datasetId", + "modelId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the model to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "modelId": { + "description": "Required. Model ID of the model to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the model to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the specified model resource by model ID.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models/{modelsId}", + "httpMethod": "GET", + "id": "bigquery.models.get", + "parameterOrder": [ + "projectId", + "datasetId", + "modelId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the requested model.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "modelId": { + "description": "Required. Model ID of the requested model.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the requested model.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}", + "response": { + "$ref": "Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists all models in the specified dataset. Requires the READER dataset role.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models", + "httpMethod": "GET", + "id": "bigquery.models.list", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the models to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "maxResults": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the models to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models", + "response": { + "$ref": "ListModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Patch specific fields in the specified model.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/models/{modelsId}", + "httpMethod": "PATCH", + "id": "bigquery.models.patch", + "parameterOrder": [ + "projectId", + "datasetId", + "modelId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the model to patch.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "modelId": { + "description": "Required. Model ID of the model to patch.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the model to patch.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}", + "request": { + "$ref": "Model" + }, + "response": { + "$ref": "Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "projects": { + "methods": { + "getServiceAccount": { + "description": "Returns the email address of the service account for your project used for interactions with Google Cloud KMS.", + "httpMethod": "GET", + "id": "bigquery.projects.getServiceAccount", + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "description": "Project ID for which the service account is requested.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/serviceAccount", + "response": { + "$ref": "GetServiceAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists all projects to which you have been granted any project role.", + "httpMethod": "GET", + "id": "bigquery.projects.list", + "parameters": { + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + } + }, + "path": "projects", + "response": { + "$ref": "ProjectList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "routines": { + "methods": { + "delete": { + "description": "Deletes the routine specified by routineId from the dataset.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}", + "httpMethod": "DELETE", + "id": "bigquery.routines.delete", + "parameterOrder": [ + "projectId", + "datasetId", + "routineId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the routine to delete", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the routine to delete", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "routineId": { + "description": "Required. Routine ID of the routine to delete", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the specified routine resource by routine ID.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}", + "httpMethod": "GET", + "id": "bigquery.routines.get", + "parameterOrder": [ + "projectId", + "datasetId", + "routineId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the requested routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the requested routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "routineId": { + "description": "Required. Routine ID of the requested routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}", + "response": { + "$ref": "Routine" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Creates a new routine in the dataset.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines", + "httpMethod": "POST", + "id": "bigquery.routines.insert", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the new routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the new routine", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines", + "request": { + "$ref": "Routine" + }, + "response": { + "$ref": "Routine" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all routines in the specified dataset. Requires the READER dataset role.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines", + "httpMethod": "GET", + "id": "bigquery.routines.list", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the routines to list", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "If set, then only the Routines matching this filter are returned. The current supported form is either \"routine_type:\" or \"routineType:\", where is a RoutineType enum. Example: \"routineType:SCALAR_FUNCTION\".", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the routines to list", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines", + "response": { + "$ref": "ListRoutinesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "update": { + "description": "Updates information in an existing routine. The update method replaces the entire Routine resource.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}", + "httpMethod": "PUT", + "id": "bigquery.routines.update", + "parameterOrder": [ + "projectId", + "datasetId", + "routineId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the routine to update", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the routine to update", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "routineId": { + "description": "Required. Routine ID of the routine to update", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}", + "request": { + "$ref": "Routine" + }, + "response": { + "$ref": "Routine" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "rowAccessPolicies": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists all row access policies on the specified table.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies", + "httpMethod": "GET", + "id": "bigquery.rowAccessPolicies.list", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of row access policies to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the row access policies to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to list row access policies.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies", + "response": { + "$ref": "ListRowAccessPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "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": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "tabledata": { + "methods": { + "insertAll": { + "description": "Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.", + "httpMethod": "POST", + "id": "bigquery.tabledata.insertAll", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the destination table.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the destination table.", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the destination table.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll", + "request": { + "$ref": "TableDataInsertAllRequest" + }, + "response": { + "$ref": "TableDataInsertAllResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.insertdata", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Retrieves table data from a specified set of rows. Requires the READER dataset role.", + "httpMethod": "GET", + "id": "bigquery.tabledata.list", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to read", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, identifying the result set", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to read", + "location": "path", + "required": true, + "type": "string" + }, + "selectedFields": { + "description": "List of fields to return (comma-separated). If unspecified, all fields are returned", + "location": "query", + "type": "string" + }, + "startIndex": { + "description": "Zero-based index of the starting row to read", + "format": "uint64", + "location": "query", + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to read", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data", + "response": { + "$ref": "TableDataList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "tables": { + "methods": { + "delete": { + "description": "Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.", + "httpMethod": "DELETE", + "id": "bigquery.tables.delete", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to delete", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to delete", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to delete", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.", + "httpMethod": "GET", + "id": "bigquery.tables.get", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the requested table", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the requested table", + "location": "path", + "required": true, + "type": "string" + }, + "selectedFields": { + "description": "List of fields to return (comma-separated). If unspecified, all fields are returned", + "location": "query", + "type": "string" + }, + "tableId": { + "description": "Table ID of the requested table", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "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": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:getIamPolicy", + "httpMethod": "POST", + "id": "bigquery.tables.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "insert": { + "description": "Creates a new, empty table in the dataset.", + "httpMethod": "POST", + "id": "bigquery.tables.insert", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the new table", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the new table", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables", + "request": { + "$ref": "Table" + }, + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all tables in the specified dataset. Requires the READER dataset role.", + "httpMethod": "GET", + "id": "bigquery.tables.list", + "parameterOrder": [ + "projectId", + "datasetId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the tables to list", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "description": "Maximum number of results to return", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Project ID of the tables to list", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables", + "response": { + "$ref": "TableList" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.", + "httpMethod": "PATCH", + "id": "bigquery.tables.patch", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to update", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "request": { + "$ref": "Table" + }, + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigquery.tables.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigquery.tables.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "update": { + "description": "Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.", + "httpMethod": "PUT", + "id": "bigquery.tables.update", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Dataset ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Project ID of the table to update", + "location": "path", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Table ID of the table to update", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{projectId}/datasets/{datasetId}/tables/{tableId}", + "request": { + "$ref": "Table" + }, + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + }, + "revision": "20210404", + "rootUrl": "https://bigquery.googleapis.com/", + "schemas": { + "AggregateClassificationMetrics": { + "description": "Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows.", + "id": "AggregateClassificationMetrics", + "properties": { + "accuracy": { + "description": "Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "logLoss": { + "description": "Logarithmic Loss. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "precision": { + "description": "Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.", + "format": "double", + "type": "number" + }, + "recall": { + "description": "Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "rocAuc": { + "description": "Area Under a ROC Curve. For multiclass this is a macro-averaged metric.", + "format": "double", + "type": "number" + }, + "threshold": { + "description": "Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Argument": { + "description": "Input/output argument of a function or a stored procedure.", + "id": "Argument", + "properties": { + "argumentKind": { + "description": "Optional. Defaults to FIXED_TYPE.", + "enum": [ + "ARGUMENT_KIND_UNSPECIFIED", + "FIXED_TYPE", + "ANY_TYPE" + ], + "enumDescriptions": [ + "", + "The argument is a variable with fully specified type, which can be a struct or an array, but not a table.", + "The argument is any type, including struct or array, but not a table. To be added: FIXED_TABLE, ANY_TABLE" + ], + "type": "string" + }, + "dataType": { + "$ref": "StandardSqlDataType", + "description": "Required unless argument_kind = ANY_TYPE." + }, + "mode": { + "description": "Optional. Specifies whether the argument is input or output. Can be set for procedures only.", + "enum": [ + "MODE_UNSPECIFIED", + "IN", + "OUT", + "INOUT" + ], + "enumDescriptions": [ + "", + "The argument is input-only.", + "The argument is output-only.", + "The argument is both an input and an output." + ], + "type": "string" + }, + "name": { + "description": "Optional. The name of this argument. Can be absent for function return argument.", + "type": "string" + } + }, + "type": "object" + }, + "ArimaCoefficients": { + "description": "Arima coefficients.", + "id": "ArimaCoefficients", + "properties": { + "autoRegressiveCoefficients": { + "description": "Auto-regressive coefficients, an array of double.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "interceptCoefficient": { + "description": "Intercept coefficient, just a double not an array.", + "format": "double", + "type": "number" + }, + "movingAverageCoefficients": { + "description": "Moving-average coefficients, an array of double.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArimaFittingMetrics": { + "description": "ARIMA model fitting metrics.", + "id": "ArimaFittingMetrics", + "properties": { + "aic": { + "description": "AIC.", + "format": "double", + "type": "number" + }, + "logLikelihood": { + "description": "Log-likelihood.", + "format": "double", + "type": "number" + }, + "variance": { + "description": "Variance.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ArimaForecastingMetrics": { + "description": "Model evaluation metrics for ARIMA forecasting models.", + "id": "ArimaForecastingMetrics", + "properties": { + "arimaFittingMetrics": { + "description": "Arima model fitting metrics.", + "items": { + "$ref": "ArimaFittingMetrics" + }, + "type": "array" + }, + "arimaSingleModelForecastingMetrics": { + "description": "Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.", + "items": { + "$ref": "ArimaSingleModelForecastingMetrics" + }, + "type": "array" + }, + "hasDrift": { + "description": "Whether Arima model fitted with drift or not. It is always false when d is not 1.", + "items": { + "type": "boolean" + }, + "type": "array" + }, + "nonSeasonalOrder": { + "description": "Non-seasonal order.", + "items": { + "$ref": "ArimaOrder" + }, + "type": "array" + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + }, + "timeSeriesId": { + "description": "Id to differentiate different time series for the large-scale case.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArimaModelInfo": { + "description": "Arima model information.", + "id": "ArimaModelInfo", + "properties": { + "arimaCoefficients": { + "$ref": "ArimaCoefficients", + "description": "Arima coefficients." + }, + "arimaFittingMetrics": { + "$ref": "ArimaFittingMetrics", + "description": "Arima fitting metrics." + }, + "hasDrift": { + "description": "Whether Arima model fitted with drift or not. It is always false when d is not 1.", + "type": "boolean" + }, + "hasHolidayEffect": { + "description": "If true, holiday_effect is a part of time series decomposition result.", + "type": "boolean" + }, + "hasSpikesAndDips": { + "description": "If true, spikes_and_dips is a part of time series decomposition result.", + "type": "boolean" + }, + "hasStepChanges": { + "description": "If true, step_changes is a part of time series decomposition result.", + "type": "boolean" + }, + "nonSeasonalOrder": { + "$ref": "ArimaOrder", + "description": "Non-seasonal order." + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + }, + "timeSeriesId": { + "description": "The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.", + "type": "string" + }, + "timeSeriesIds": { + "description": "The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArimaOrder": { + "description": "Arima order, can be used for both non-seasonal and seasonal parts.", + "id": "ArimaOrder", + "properties": { + "d": { + "description": "Order of the differencing part.", + "format": "int64", + "type": "string" + }, + "p": { + "description": "Order of the autoregressive part.", + "format": "int64", + "type": "string" + }, + "q": { + "description": "Order of the moving-average part.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ArimaResult": { + "description": "(Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.", + "id": "ArimaResult", + "properties": { + "arimaModelInfo": { + "description": "This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.", + "items": { + "$ref": "ArimaModelInfo" + }, + "type": "array" + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArimaSingleModelForecastingMetrics": { + "description": "Model evaluation metrics for a single ARIMA forecasting model.", + "id": "ArimaSingleModelForecastingMetrics", + "properties": { + "arimaFittingMetrics": { + "$ref": "ArimaFittingMetrics", + "description": "Arima fitting metrics." + }, + "hasDrift": { + "description": "Is arima model fitted with drift or not. It is always false when d is not 1.", + "type": "boolean" + }, + "hasHolidayEffect": { + "description": "If true, holiday_effect is a part of time series decomposition result.", + "type": "boolean" + }, + "hasSpikesAndDips": { + "description": "If true, spikes_and_dips is a part of time series decomposition result.", + "type": "boolean" + }, + "hasStepChanges": { + "description": "If true, step_changes is a part of time series decomposition result.", + "type": "boolean" + }, + "nonSeasonalOrder": { + "$ref": "ArimaOrder", + "description": "Non-seasonal order." + }, + "seasonalPeriods": { + "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", + "items": { + "enum": [ + "SEASONAL_PERIOD_TYPE_UNSPECIFIED", + "NO_SEASONALITY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enumDescriptions": [ + "", + "No seasonality", + "Daily period, 24 hours.", + "Weekly period, 7 days.", + "Monthly period, 30 days or irregular.", + "Quarterly period, 90 days or irregular.", + "Yearly period, 365 days or irregular." + ], + "type": "string" + }, + "type": "array" + }, + "timeSeriesId": { + "description": "The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.", + "type": "string" + }, + "timeSeriesIds": { + "description": "The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "BigQueryModelTraining": { + "id": "BigQueryModelTraining", + "properties": { + "currentIteration": { + "description": "[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.", + "format": "int32", + "type": "integer" + }, + "expectedTotalIterations": { + "description": "[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BigtableColumn": { + "id": "BigtableColumn", + "properties": { + "encoding": { + "description": "[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.", + "type": "string" + }, + "fieldName": { + "description": "[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.", + "type": "string" + }, + "onlyReadLatest": { + "description": "[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.", + "type": "boolean" + }, + "qualifierEncoded": { + "description": "[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.", + "format": "byte", + "type": "string" + }, + "qualifierString": { + "type": "string" + }, + "type": { + "description": "[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.", + "type": "string" + } + }, + "type": "object" + }, + "BigtableColumnFamily": { + "id": "BigtableColumnFamily", + "properties": { + "columns": { + "description": "[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.", + "items": { + "$ref": "BigtableColumn" + }, + "type": "array" + }, + "encoding": { + "description": "[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.", + "type": "string" + }, + "familyId": { + "description": "Identifier of the column family.", + "type": "string" + }, + "onlyReadLatest": { + "description": "[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.", + "type": "boolean" + }, + "type": { + "description": "[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.", + "type": "string" + } + }, + "type": "object" + }, + "BigtableOptions": { + "id": "BigtableOptions", + "properties": { + "columnFamilies": { + "description": "[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.", + "items": { + "$ref": "BigtableColumnFamily" + }, + "type": "array" + }, + "ignoreUnspecifiedColumnFamilies": { + "description": "[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.", + "type": "boolean" + }, + "readRowkeyAsString": { + "description": "[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.", + "type": "boolean" + } + }, + "type": "object" + }, + "BinaryClassificationMetrics": { + "description": "Evaluation metrics for binary classification/classifier models.", + "id": "BinaryClassificationMetrics", + "properties": { + "aggregateClassificationMetrics": { + "$ref": "AggregateClassificationMetrics", + "description": "Aggregate classification metrics." + }, + "binaryConfusionMatrixList": { + "description": "Binary confusion matrix at multiple thresholds.", + "items": { + "$ref": "BinaryConfusionMatrix" + }, + "type": "array" + }, + "negativeLabel": { + "description": "Label representing the negative class.", + "type": "string" + }, + "positiveLabel": { + "description": "Label representing the positive class.", + "type": "string" + } + }, + "type": "object" + }, + "BinaryConfusionMatrix": { + "description": "Confusion matrix for binary classification models.", + "id": "BinaryConfusionMatrix", + "properties": { + "accuracy": { + "description": "The fraction of predictions given the correct label.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The equally weighted average of recall and precision.", + "format": "double", + "type": "number" + }, + "falseNegatives": { + "description": "Number of false samples predicted as false.", + "format": "int64", + "type": "string" + }, + "falsePositives": { + "description": "Number of false samples predicted as true.", + "format": "int64", + "type": "string" + }, + "positiveClassThreshold": { + "description": "Threshold value used when computing each of the following metric.", + "format": "double", + "type": "number" + }, + "precision": { + "description": "The fraction of actual positive predictions that had positive actual labels.", + "format": "double", + "type": "number" + }, + "recall": { + "description": "The fraction of actual positive labels that were given a positive prediction.", + "format": "double", + "type": "number" + }, + "trueNegatives": { + "description": "Number of true samples predicted as false.", + "format": "int64", + "type": "string" + }, + "truePositives": { + "description": "Number of true samples predicted as true.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "BqmlIterationResult": { + "id": "BqmlIterationResult", + "properties": { + "durationMs": { + "description": "[Output-only, Beta] Time taken to run the training iteration in milliseconds.", + "format": "int64", + "type": "string" + }, + "evalLoss": { + "description": "[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.", + "format": "double", + "type": "number" + }, + "index": { + "description": "[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.", + "format": "int32", + "type": "integer" + }, + "learnRate": { + "description": "[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.", + "format": "double", + "type": "number" + }, + "trainingLoss": { + "description": "[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "BqmlTrainingRun": { + "id": "BqmlTrainingRun", + "properties": { + "iterationResults": { + "description": "[Output-only, Beta] List of each iteration results.", + "items": { + "$ref": "BqmlIterationResult" + }, + "type": "array" + }, + "startTime": { + "description": "[Output-only, Beta] Training run start time in milliseconds since the epoch.", + "format": "date-time", + "type": "string" + }, + "state": { + "description": "[Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.", + "type": "string" + }, + "trainingOptions": { + "description": "[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.", + "properties": { + "earlyStop": { + "type": "boolean" + }, + "l1Reg": { + "format": "double", + "type": "number" + }, + "l2Reg": { + "format": "double", + "type": "number" + }, + "learnRate": { + "format": "double", + "type": "number" + }, + "learnRateStrategy": { + "type": "string" + }, + "lineSearchInitLearnRate": { + "format": "double", + "type": "number" + }, + "maxIteration": { + "format": "int64", + "type": "string" + }, + "minRelProgress": { + "format": "double", + "type": "number" + }, + "warmStart": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "CategoricalValue": { + "description": "Representative value of a categorical feature.", + "id": "CategoricalValue", + "properties": { + "categoryCounts": { + "description": "Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category \"_OTHER_\" and count as aggregate counts of remaining categories.", + "items": { + "$ref": "CategoryCount" + }, + "type": "array" + } + }, + "type": "object" + }, + "CategoryCount": { + "description": "Represents the count of a single category within the cluster.", + "id": "CategoryCount", + "properties": { + "category": { + "description": "The name of category.", + "type": "string" + }, + "count": { + "description": "The count of training samples matching the category within the cluster.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Cluster": { + "description": "Message containing the information about one cluster.", + "id": "Cluster", + "properties": { + "centroidId": { + "description": "Centroid id.", + "format": "int64", + "type": "string" + }, + "count": { + "description": "Count of training data rows that were assigned to this cluster.", + "format": "int64", + "type": "string" + }, + "featureValues": { + "description": "Values of highly variant features for this cluster.", + "items": { + "$ref": "FeatureValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClusterInfo": { + "description": "Information about a single cluster for clustering model.", + "id": "ClusterInfo", + "properties": { + "centroidId": { + "description": "Centroid id.", + "format": "int64", + "type": "string" + }, + "clusterRadius": { + "description": "Cluster radius, the average distance from centroid to each point assigned to the cluster.", + "format": "double", + "type": "number" + }, + "clusterSize": { + "description": "Cluster size, the total number of points assigned to the cluster.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Clustering": { + "id": "Clustering", + "properties": { + "fields": { + "description": "[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClusteringMetrics": { + "description": "Evaluation metrics for clustering models.", + "id": "ClusteringMetrics", + "properties": { + "clusters": { + "description": "Information for all clusters.", + "items": { + "$ref": "Cluster" + }, + "type": "array" + }, + "daviesBouldinIndex": { + "description": "Davies-Bouldin index.", + "format": "double", + "type": "number" + }, + "meanSquaredDistance": { + "description": "Mean of squared distances between each sample to its cluster centroid.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ConfusionMatrix": { + "description": "Confusion matrix for multi-class classification models.", + "id": "ConfusionMatrix", + "properties": { + "confidenceThreshold": { + "description": "Confidence threshold used when computing the entries of the confusion matrix.", + "format": "double", + "type": "number" + }, + "rows": { + "description": "One row per actual label.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConnectionProperty": { + "id": "ConnectionProperty", + "properties": { + "key": { + "description": "[Required] Name of the connection property to set.", + "type": "string" + }, + "value": { + "description": "[Required] Value of the connection property.", + "type": "string" + } + }, + "type": "object" + }, + "CsvOptions": { + "id": "CsvOptions", + "properties": { + "allowJaggedRows": { + "description": "[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.", + "type": "boolean" + }, + "allowQuotedNewlines": { + "description": "[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.", + "type": "boolean" + }, + "encoding": { + "description": "[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.", + "type": "string" + }, + "fieldDelimiter": { + "description": "[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence \"\\t\" to specify a tab separator. The default value is a comma (',').", + "type": "string" + }, + "quote": { + "default": "\"", + "description": "[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.", + "pattern": ".?", + "type": "string" + }, + "skipLeadingRows": { + "description": "[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DataSplitResult": { + "description": "Data split result. This contains references to the training and evaluation data tables that were used to train the model.", + "id": "DataSplitResult", + "properties": { + "evaluationTable": { + "$ref": "TableReference", + "description": "Table reference of the evaluation data after split." + }, + "trainingTable": { + "$ref": "TableReference", + "description": "Table reference of the training data after split." + } + }, + "type": "object" + }, + "Dataset": { + "id": "Dataset", + "properties": { + "access": { + "description": "[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;", + "items": { + "properties": { + "dataset": { + "$ref": "DatasetAccessEntry", + "description": "[Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation." + }, + "domain": { + "description": "[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\". Maps to IAM policy member \"domain:DOMAIN\".", + "type": "string" + }, + "groupByEmail": { + "description": "[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member \"group:GROUP\".", + "type": "string" + }, + "iamMember": { + "description": "[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.", + "type": "string" + }, + "role": { + "description": "[Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", + "type": "string" + }, + "routine": { + "$ref": "RoutineReference", + "description": "[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation." + }, + "specialGroup": { + "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", + "type": "string" + }, + "userByEmail": { + "description": "[Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member \"user:EMAIL\" or \"serviceAccount:EMAIL\".", + "type": "string" + }, + "view": { + "$ref": "TableReference", + "description": "[Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation." + } + }, + "type": "object" + }, + "type": "array" + }, + "creationTime": { + "description": "[Output-only] The time when this dataset was created, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "datasetReference": { + "$ref": "DatasetReference", + "description": "[Required] A reference that identifies the dataset." + }, + "defaultEncryptionConfiguration": { + "$ref": "EncryptionConfiguration" + }, + "defaultPartitionExpirationMs": { + "description": "[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.", + "format": "int64", + "type": "string" + }, + "defaultTableExpirationMs": { + "description": "[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "[Optional] A user-friendly description of the dataset.", + "type": "string" + }, + "etag": { + "description": "[Output-only] A hash of the resource.", + "type": "string" + }, + "friendlyName": { + "description": "[Optional] A descriptive name for the dataset.", + "type": "string" + }, + "id": { + "description": "[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.", + "type": "string" + }, + "kind": { + "default": "bigquery#dataset", + "description": "[Output-only] The resource type.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.", + "type": "object" + }, + "lastModifiedTime": { + "description": "[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "location": { + "description": "The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.", + "type": "string" + }, + "satisfiesPZS": { + "description": "[Output-only] Reserved for future use.", + "type": "boolean" + }, + "selfLink": { + "description": "[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.", + "type": "string" + } + }, + "type": "object" + }, + "DatasetAccessEntry": { + "id": "DatasetAccessEntry", + "properties": { + "dataset": { + "$ref": "DatasetReference", + "description": "[Required] The dataset this entry applies to." + }, + "target_types": { + "items": { + "properties": { + "targetType": { + "description": "[Required] Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS: This entry applies to all views in the dataset.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "DatasetList": { + "id": "DatasetList", + "properties": { + "datasets": { + "description": "An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.", + "items": { + "properties": { + "datasetReference": { + "$ref": "DatasetReference", + "description": "The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID." + }, + "friendlyName": { + "description": "A descriptive name for the dataset, if one exists.", + "type": "string" + }, + "id": { + "description": "The fully-qualified, unique, opaque ID of the dataset.", + "type": "string" + }, + "kind": { + "default": "bigquery#dataset", + "description": "The resource type. This property always returns the value \"bigquery#dataset\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this dataset. You can use these to organize and group your datasets.", + "type": "object" + }, + "location": { + "description": "The geographic location where the data resides.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "etag": { + "description": "A hash value of the results page. You can use this property to determine if the page has changed since the last request.", + "type": "string" + }, + "kind": { + "default": "bigquery#datasetList", + "description": "The list type. This property always returns the value \"bigquery#datasetList\".", + "type": "string" + }, + "nextPageToken": { + "description": "A token that can be used to request the next results page. This property is omitted on the final results page.", + "type": "string" + } + }, + "type": "object" + }, + "DatasetReference": { + "id": "DatasetReference", + "properties": { + "datasetId": { + "annotations": { + "required": [ + "bigquery.datasets.update" + ] + }, + "description": "[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.", + "type": "string" + }, + "projectId": { + "annotations": { + "required": [ + "bigquery.datasets.update" + ] + }, + "description": "[Optional] The ID of the project containing this dataset.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationTableProperties": { + "id": "DestinationTableProperties", + "properties": { + "description": { + "description": "[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.", + "type": "string" + }, + "friendlyName": { + "description": "[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.", + "type": "object" + } + }, + "type": "object" + }, + "EncryptionConfiguration": { + "id": "EncryptionConfiguration", + "properties": { + "kmsKeyName": { + "description": "[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.", + "type": "string" + } + }, + "type": "object" + }, + "Entry": { + "description": "A single entry in the confusion matrix.", + "id": "Entry", + "properties": { + "itemCount": { + "description": "Number of items being predicted as this label.", + "format": "int64", + "type": "string" + }, + "predictedLabel": { + "description": "The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.", + "type": "string" + } + }, + "type": "object" + }, + "ErrorProto": { + "id": "ErrorProto", + "properties": { + "debugInfo": { + "description": "Debugging information. This property is internal to Google and should not be used.", + "type": "string" + }, + "location": { + "description": "Specifies where the error occurred, if present.", + "type": "string" + }, + "message": { + "description": "A human-readable description of the error.", + "type": "string" + }, + "reason": { + "description": "A short error code that summarizes the error.", + "type": "string" + } + }, + "type": "object" + }, + "EvaluationMetrics": { + "description": "Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.", + "id": "EvaluationMetrics", + "properties": { + "arimaForecastingMetrics": { + "$ref": "ArimaForecastingMetrics", + "description": "Populated for ARIMA models." + }, + "binaryClassificationMetrics": { + "$ref": "BinaryClassificationMetrics", + "description": "Populated for binary classification/classifier models." + }, + "clusteringMetrics": { + "$ref": "ClusteringMetrics", + "description": "Populated for clustering models." + }, + "multiClassClassificationMetrics": { + "$ref": "MultiClassClassificationMetrics", + "description": "Populated for multi-class classification/classifier models." + }, + "rankingMetrics": { + "$ref": "RankingMetrics", + "description": "Populated for implicit feedback type matrix factorization models." + }, + "regressionMetrics": { + "$ref": "RegressionMetrics", + "description": "Populated for regression models and explicit feedback type matrix factorization models." + } + }, + "type": "object" + }, + "ExplainQueryStage": { + "id": "ExplainQueryStage", + "properties": { + "completedParallelInputs": { + "description": "Number of parallel input segments completed.", + "format": "int64", + "type": "string" + }, + "computeMsAvg": { + "description": "Milliseconds the average shard spent on CPU-bound tasks.", + "format": "int64", + "type": "string" + }, + "computeMsMax": { + "description": "Milliseconds the slowest shard spent on CPU-bound tasks.", + "format": "int64", + "type": "string" + }, + "computeRatioAvg": { + "description": "Relative amount of time the average shard spent on CPU-bound tasks.", + "format": "double", + "type": "number" + }, + "computeRatioMax": { + "description": "Relative amount of time the slowest shard spent on CPU-bound tasks.", + "format": "double", + "type": "number" + }, + "endMs": { + "description": "Stage end time represented as milliseconds since epoch.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "Unique ID for stage within plan.", + "format": "int64", + "type": "string" + }, + "inputStages": { + "description": "IDs for stages that are inputs to this stage.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Human-readable name for stage.", + "type": "string" + }, + "parallelInputs": { + "description": "Number of parallel input segments to be processed.", + "format": "int64", + "type": "string" + }, + "readMsAvg": { + "description": "Milliseconds the average shard spent reading input.", + "format": "int64", + "type": "string" + }, + "readMsMax": { + "description": "Milliseconds the slowest shard spent reading input.", + "format": "int64", + "type": "string" + }, + "readRatioAvg": { + "description": "Relative amount of time the average shard spent reading input.", + "format": "double", + "type": "number" + }, + "readRatioMax": { + "description": "Relative amount of time the slowest shard spent reading input.", + "format": "double", + "type": "number" + }, + "recordsRead": { + "description": "Number of records read into the stage.", + "format": "int64", + "type": "string" + }, + "recordsWritten": { + "description": "Number of records written by the stage.", + "format": "int64", + "type": "string" + }, + "shuffleOutputBytes": { + "description": "Total number of bytes written to shuffle.", + "format": "int64", + "type": "string" + }, + "shuffleOutputBytesSpilled": { + "description": "Total number of bytes written to shuffle and spilled to disk.", + "format": "int64", + "type": "string" + }, + "slotMs": { + "description": "Slot-milliseconds used by the stage.", + "format": "int64", + "type": "string" + }, + "startMs": { + "description": "Stage start time represented as milliseconds since epoch.", + "format": "int64", + "type": "string" + }, + "status": { + "description": "Current status for the stage.", + "type": "string" + }, + "steps": { + "description": "List of operations within the stage in dependency order (approximately chronological).", + "items": { + "$ref": "ExplainQueryStep" + }, + "type": "array" + }, + "waitMsAvg": { + "description": "Milliseconds the average shard spent waiting to be scheduled.", + "format": "int64", + "type": "string" + }, + "waitMsMax": { + "description": "Milliseconds the slowest shard spent waiting to be scheduled.", + "format": "int64", + "type": "string" + }, + "waitRatioAvg": { + "description": "Relative amount of time the average shard spent waiting to be scheduled.", + "format": "double", + "type": "number" + }, + "waitRatioMax": { + "description": "Relative amount of time the slowest shard spent waiting to be scheduled.", + "format": "double", + "type": "number" + }, + "writeMsAvg": { + "description": "Milliseconds the average shard spent on writing output.", + "format": "int64", + "type": "string" + }, + "writeMsMax": { + "description": "Milliseconds the slowest shard spent on writing output.", + "format": "int64", + "type": "string" + }, + "writeRatioAvg": { + "description": "Relative amount of time the average shard spent on writing output.", + "format": "double", + "type": "number" + }, + "writeRatioMax": { + "description": "Relative amount of time the slowest shard spent on writing output.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ExplainQueryStep": { + "id": "ExplainQueryStep", + "properties": { + "kind": { + "description": "Machine-readable operation type.", + "type": "string" + }, + "substeps": { + "description": "Human-readable stage descriptions.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Explanation": { + "description": "Explanation for a single feature.", + "id": "Explanation", + "properties": { + "attribution": { + "description": "Attribution of feature.", + "format": "double", + "type": "number" + }, + "featureName": { + "description": "Full name of the feature. For non-numerical features, will be formatted like .. Overall size of feature name will always be truncated to first 120 characters.", + "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" + }, + "ExternalDataConfiguration": { + "id": "ExternalDataConfiguration", + "properties": { + "autodetect": { + "description": "Try to detect schema and format options automatically. Any option specified explicitly will be honored.", + "type": "boolean" + }, + "bigtableOptions": { + "$ref": "BigtableOptions", + "description": "[Optional] Additional options if sourceFormat is set to BIGTABLE." + }, + "compression": { + "description": "[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.", + "type": "string" + }, + "connectionId": { + "description": "[Optional, Trusted Tester] Connection for external data source.", + "type": "string" + }, + "csvOptions": { + "$ref": "CsvOptions", + "description": "Additional properties to set if sourceFormat is set to CSV." + }, + "googleSheetsOptions": { + "$ref": "GoogleSheetsOptions", + "description": "[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS." + }, + "hivePartitioningOptions": { + "$ref": "HivePartitioningOptions", + "description": "[Optional] Options to configure hive partitioning support." + }, + "ignoreUnknownValues": { + "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.", + "type": "boolean" + }, + "maxBadRecords": { + "description": "[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.", + "format": "int32", + "type": "integer" + }, + "parquetOptions": { + "$ref": "ParquetOptions", + "description": "Additional properties to set if sourceFormat is set to Parquet." + }, + "schema": { + "$ref": "TableSchema", + "description": "[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats." + }, + "sourceFormat": { + "description": "[Required] The data format. For CSV files, specify \"CSV\". For Google sheets, specify \"GOOGLE_SHEETS\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro files, specify \"AVRO\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\". [Beta] For Google Cloud Bigtable, specify \"BIGTABLE\".", + "type": "string" + }, + "sourceUris": { + "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FeatureValue": { + "description": "Representative value of a single feature within the cluster.", + "id": "FeatureValue", + "properties": { + "categoricalValue": { + "$ref": "CategoricalValue", + "description": "The categorical feature value." + }, + "featureColumn": { + "description": "The feature column name.", + "type": "string" + }, + "numericalValue": { + "description": "The numerical feature value. This is the centroid value for this feature.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GetIamPolicyRequest": { + "description": "Request message for `GetIamPolicy` method.", + "id": "GetIamPolicyRequest", + "properties": { + "options": { + "$ref": "GetPolicyOptions", + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." + } + }, + "type": "object" + }, + "GetPolicyOptions": { + "description": "Encapsulates settings provided to GetIamPolicy.", + "id": "GetPolicyOptions", + "properties": { + "requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GetQueryResultsResponse": { + "id": "GetQueryResultsResponse", + "properties": { + "cacheHit": { + "description": "Whether the query result was fetched from the query cache.", + "type": "boolean" + }, + "errors": { + "description": "[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "etag": { + "description": "A hash of this response.", + "type": "string" + }, + "jobComplete": { + "description": "Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.", + "type": "boolean" + }, + "jobReference": { + "$ref": "JobReference", + "description": "Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults)." + }, + "kind": { + "default": "bigquery#getQueryResultsResponse", + "description": "The resource type of the response.", + "type": "string" + }, + "numDmlAffectedRows": { + "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.", + "format": "int64", + "type": "string" + }, + "pageToken": { + "description": "A token used for paging results.", + "type": "string" + }, + "rows": { + "description": "An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.", + "items": { + "$ref": "TableRow" + }, + "type": "array" + }, + "schema": { + "$ref": "TableSchema", + "description": "The schema of the results. Present only when the query completes successfully." + }, + "totalBytesProcessed": { + "description": "The total number of bytes processed for this query.", + "format": "int64", + "type": "string" + }, + "totalRows": { + "description": "The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "GetServiceAccountResponse": { + "id": "GetServiceAccountResponse", + "properties": { + "email": { + "description": "The service account email address.", + "type": "string" + }, + "kind": { + "default": "bigquery#getServiceAccountResponse", + "description": "The resource type of the response.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalExplanation": { + "description": "Global explanations containing the top most important features after training.", + "id": "GlobalExplanation", + "properties": { + "classLabel": { + "description": "Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.", + "type": "string" + }, + "explanations": { + "description": "A list of the top global explanations. Sorted by absolute value of attribution in descending order.", + "items": { + "$ref": "Explanation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleSheetsOptions": { + "id": "GoogleSheetsOptions", + "properties": { + "range": { + "description": "[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20", + "type": "string" + }, + "skipLeadingRows": { + "description": "[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "HivePartitioningOptions": { + "id": "HivePartitioningOptions", + "properties": { + "mode": { + "description": "[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.", + "type": "string" + }, + "requirePartitionFilter": { + "description": "[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.", + "type": "boolean" + }, + "sourceUriPrefix": { + "description": "[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).", + "type": "string" + } + }, + "type": "object" + }, + "IterationResult": { + "description": "Information about a single iteration of the training run.", + "id": "IterationResult", + "properties": { + "arimaResult": { + "$ref": "ArimaResult" + }, + "clusterInfos": { + "description": "Information about top clusters for clustering models.", + "items": { + "$ref": "ClusterInfo" + }, + "type": "array" + }, + "durationMs": { + "description": "Time taken to run the iteration in milliseconds.", + "format": "int64", + "type": "string" + }, + "evalLoss": { + "description": "Loss computed on the eval data at the end of iteration.", + "format": "double", + "type": "number" + }, + "index": { + "description": "Index of the iteration, 0 based.", + "format": "int32", + "type": "integer" + }, + "learnRate": { + "description": "Learn rate used for this iteration.", + "format": "double", + "type": "number" + }, + "trainingLoss": { + "description": "Loss computed on the training data at the end of iteration.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Job": { + "id": "Job", + "properties": { + "configuration": { + "$ref": "JobConfiguration", + "description": "[Required] Describes the job configuration." + }, + "etag": { + "description": "[Output-only] A hash of this resource.", + "type": "string" + }, + "id": { + "description": "[Output-only] Opaque ID field of the job", + "type": "string" + }, + "jobReference": { + "$ref": "JobReference", + "description": "[Optional] Reference describing the unique-per-user name of the job." + }, + "kind": { + "default": "bigquery#job", + "description": "[Output-only] The type of the resource.", + "type": "string" + }, + "selfLink": { + "description": "[Output-only] A URL that can be used to access this resource again.", + "type": "string" + }, + "statistics": { + "$ref": "JobStatistics", + "description": "[Output-only] Information about the job, including starting time and ending time of the job." + }, + "status": { + "$ref": "JobStatus", + "description": "[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete." + }, + "user_email": { + "description": "[Output-only] Email address of the user who ran the job.", + "type": "string" + } + }, + "type": "object" + }, + "JobCancelResponse": { + "id": "JobCancelResponse", + "properties": { + "job": { + "$ref": "Job", + "description": "The final state of the job." + }, + "kind": { + "default": "bigquery#jobCancelResponse", + "description": "The resource type of the response.", + "type": "string" + } + }, + "type": "object" + }, + "JobConfiguration": { + "id": "JobConfiguration", + "properties": { + "copy": { + "$ref": "JobConfigurationTableCopy", + "description": "[Pick one] Copies a table." + }, + "dryRun": { + "description": "[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.", + "type": "boolean" + }, + "extract": { + "$ref": "JobConfigurationExtract", + "description": "[Pick one] Configures an extract job." + }, + "jobTimeoutMs": { + "description": "[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.", + "format": "int64", + "type": "string" + }, + "jobType": { + "description": "[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "load": { + "$ref": "JobConfigurationLoad", + "description": "[Pick one] Configures a load job." + }, + "query": { + "$ref": "JobConfigurationQuery", + "description": "[Pick one] Configures a query job." + } + }, + "type": "object" + }, + "JobConfigurationExtract": { + "id": "JobConfigurationExtract", + "properties": { + "compression": { + "description": "[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.", + "type": "string" + }, + "destinationFormat": { + "description": "[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.", + "type": "string" + }, + "destinationUri": { + "description": "[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.", + "type": "string" + }, + "destinationUris": { + "description": "[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fieldDelimiter": { + "description": "[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.", + "type": "string" + }, + "printHeader": { + "default": "true", + "description": "[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.", + "type": "boolean" + }, + "sourceModel": { + "$ref": "ModelReference", + "description": "A reference to the model being exported." + }, + "sourceTable": { + "$ref": "TableReference", + "description": "A reference to the table being exported." + }, + "useAvroLogicalTypes": { + "description": "[Optional] If destinationFormat is set to \"AVRO\", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.", + "type": "boolean" + } + }, + "type": "object" + }, + "JobConfigurationLoad": { + "id": "JobConfigurationLoad", + "properties": { + "allowJaggedRows": { + "description": "[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.", + "type": "boolean" + }, + "allowQuotedNewlines": { + "description": "Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.", + "type": "boolean" + }, + "autodetect": { + "description": "[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.", + "type": "boolean" + }, + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered." + }, + "createDisposition": { + "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + }, + "decimalTargetTypes": { + "description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC ([Preview](/products/#product-launch-stages)), and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", + "items": { + "type": "string" + }, + "type": "array" + }, + "destinationEncryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "destinationTable": { + "$ref": "TableReference", + "description": "[Required] The destination table to load the data into." + }, + "destinationTableProperties": { + "$ref": "DestinationTableProperties", + "description": "[Beta] [Optional] Properties with which to create the destination table if it is new." + }, + "encoding": { + "description": "[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.", + "type": "string" + }, + "fieldDelimiter": { + "description": "[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence \"\\t\" to specify a tab separator. The default value is a comma (',').", + "type": "string" + }, + "hivePartitioningOptions": { + "$ref": "HivePartitioningOptions", + "description": "[Optional] Options to configure hive partitioning support." + }, + "ignoreUnknownValues": { + "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names", + "type": "boolean" + }, + "jsonExtension": { + "description": "[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.", + "type": "string" + }, + "maxBadRecords": { + "description": "[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.", + "format": "int32", + "type": "integer" + }, + "nullMarker": { + "description": "[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.", + "type": "string" + }, + "parquetOptions": { + "$ref": "ParquetOptions", + "description": "[Optional] Options to configure parquet support." + }, + "projectionFields": { + "description": "If sourceFormat is set to \"DATASTORE_BACKUP\", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.", + "items": { + "type": "string" + }, + "type": "array" + }, + "quote": { + "default": "\"", + "description": "[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.", + "pattern": ".?", + "type": "string" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "schema": { + "$ref": "TableSchema", + "description": "[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore." + }, + "schemaInline": { + "description": "[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\".", + "type": "string" + }, + "schemaInlineFormat": { + "description": "[Deprecated] The format of the schemaInline property.", + "type": "string" + }, + "schemaUpdateOptions": { + "description": "Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", + "items": { + "type": "string" + }, + "type": "array" + }, + "skipLeadingRows": { + "description": "[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.", + "format": "int32", + "type": "integer" + }, + "sourceFormat": { + "description": "[Optional] The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro, specify \"AVRO\". For parquet, specify \"PARQUET\". For orc, specify \"ORC\". The default value is CSV.", + "type": "string" + }, + "sourceUris": { + "description": "[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "useAvroLogicalTypes": { + "description": "[Optional] If sourceFormat is set to \"AVRO\", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).", + "type": "boolean" + }, + "writeDisposition": { + "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + } + }, + "type": "object" + }, + "JobConfigurationQuery": { + "id": "JobConfigurationQuery", + "properties": { + "allowLargeResults": { + "default": "false", + "description": "[Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.", + "type": "boolean" + }, + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered." + }, + "connectionProperties": { + "description": "Connection properties.", + "items": { + "$ref": "ConnectionProperty" + }, + "type": "array" + }, + "createDisposition": { + "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + }, + "createSession": { + "description": "If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.", + "type": "boolean" + }, + "defaultDataset": { + "$ref": "DatasetReference", + "description": "[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names." + }, + "destinationEncryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "destinationTable": { + "$ref": "TableReference", + "description": "[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size." + }, + "flattenResults": { + "default": "true", + "description": "[Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.", + "type": "boolean" + }, + "maximumBillingTier": { + "default": "1", + "description": "[Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.", + "format": "int32", + "type": "integer" + }, + "maximumBytesBilled": { + "description": "[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.", + "format": "int64", + "type": "string" + }, + "parameterMode": { + "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.", + "type": "string" + }, + "preserveNulls": { + "description": "[Deprecated] This property is deprecated.", + "type": "boolean" + }, + "priority": { + "description": "[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.", + "type": "string" + }, + "query": { + "description": "[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.", + "type": "string" + }, + "queryParameters": { + "description": "Query parameters for standard SQL queries.", + "items": { + "$ref": "QueryParameter" + }, + "type": "array" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "schemaUpdateOptions": { + "description": "Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tableDefinitions": { + "additionalProperties": { + "$ref": "ExternalDataConfiguration" + }, + "description": "[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.", + "type": "object" + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "useLegacySql": { + "default": "true", + "description": "Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.", + "type": "boolean" + }, + "useQueryCache": { + "default": "true", + "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.", + "type": "boolean" + }, + "userDefinedFunctionResources": { + "description": "Describes user-defined function resources used in the query.", + "items": { + "$ref": "UserDefinedFunctionResource" + }, + "type": "array" + }, + "writeDisposition": { + "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + } + }, + "type": "object" + }, + "JobConfigurationTableCopy": { + "id": "JobConfigurationTableCopy", + "properties": { + "createDisposition": { + "description": "[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + }, + "destinationEncryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "destinationExpirationTime": { + "description": "[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.", + "type": "any" + }, + "destinationTable": { + "$ref": "TableReference", + "description": "[Required] The destination table" + }, + "operationType": { + "description": "[Optional] Supported operation types in table copy job.", + "type": "string" + }, + "sourceTable": { + "$ref": "TableReference", + "description": "[Pick one] Source table to copy." + }, + "sourceTables": { + "description": "[Pick one] Source tables to copy.", + "items": { + "$ref": "TableReference" + }, + "type": "array" + }, + "writeDisposition": { + "description": "[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "type": "string" + } + }, + "type": "object" + }, + "JobList": { + "id": "JobList", + "properties": { + "etag": { + "description": "A hash of this page of results.", + "type": "string" + }, + "jobs": { + "description": "List of jobs that were requested.", + "items": { + "properties": { + "configuration": { + "$ref": "JobConfiguration", + "description": "[Full-projection-only] Specifies the job configuration." + }, + "errorResult": { + "$ref": "ErrorProto", + "description": "A result object that will be present only if the job has failed." + }, + "id": { + "description": "Unique opaque ID of the job.", + "type": "string" + }, + "jobReference": { + "$ref": "JobReference", + "description": "Job reference uniquely identifying the job." + }, + "kind": { + "default": "bigquery#job", + "description": "The resource type.", + "type": "string" + }, + "state": { + "description": "Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.", + "type": "string" + }, + "statistics": { + "$ref": "JobStatistics", + "description": "[Output-only] Information about the job, including starting time and ending time of the job." + }, + "status": { + "$ref": "JobStatus", + "description": "[Full-projection-only] Describes the state of the job." + }, + "user_email": { + "description": "[Full-projection-only] Email address of the user who ran the job.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "kind": { + "default": "bigquery#jobList", + "description": "The resource type of the response.", + "type": "string" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "JobReference": { + "id": "JobReference", + "properties": { + "jobId": { + "annotations": { + "required": [ + "bigquery.jobs.getQueryResults" + ] + }, + "description": "[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.", + "type": "string" + }, + "location": { + "description": "The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "type": "string" + }, + "projectId": { + "annotations": { + "required": [ + "bigquery.jobs.getQueryResults" + ] + }, + "description": "[Required] The ID of the project containing this job.", + "type": "string" + } + }, + "type": "object" + }, + "JobStatistics": { + "id": "JobStatistics", + "properties": { + "completionRatio": { + "description": "[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.", + "format": "double", + "type": "number" + }, + "creationTime": { + "description": "[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.", + "format": "int64", + "type": "string" + }, + "endTime": { + "description": "[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.", + "format": "int64", + "type": "string" + }, + "extract": { + "$ref": "JobStatistics4", + "description": "[Output-only] Statistics for an extract job." + }, + "load": { + "$ref": "JobStatistics3", + "description": "[Output-only] Statistics for a load job." + }, + "numChildJobs": { + "description": "[Output-only] Number of child jobs executed.", + "format": "int64", + "type": "string" + }, + "parentJobId": { + "description": "[Output-only] If this is a child job, the id of the parent.", + "type": "string" + }, + "query": { + "$ref": "JobStatistics2", + "description": "[Output-only] Statistics for a query job." + }, + "quotaDeferments": { + "description": "[Output-only] Quotas which delayed this job's start time.", + "items": { + "type": "string" + }, + "type": "array" + }, + "reservationUsage": { + "description": "[Output-only] Job resource usage breakdown by reservation.", + "items": { + "properties": { + "name": { + "description": "[Output-only] Reservation name or \"unreserved\" for on-demand resources usage.", + "type": "string" + }, + "slotMs": { + "description": "[Output-only] Slot-milliseconds the job spent in the given reservation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "reservation_id": { + "description": "[Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.", + "type": "string" + }, + "rowLevelSecurityStatistics": { + "$ref": "RowLevelSecurityStatistics", + "description": "[Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs." + }, + "scriptStatistics": { + "$ref": "ScriptStatistics", + "description": "[Output-only] Statistics for a child job of a script." + }, + "sessionInfoTemplate": { + "$ref": "SessionInfo", + "description": "[Output-only] [Preview] Information of the session if this job is part of one." + }, + "startTime": { + "description": "[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.", + "format": "int64", + "type": "string" + }, + "totalBytesProcessed": { + "description": "[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.", + "format": "int64", + "type": "string" + }, + "totalSlotMs": { + "description": "[Output-only] Slot-milliseconds for the job.", + "format": "int64", + "type": "string" + }, + "transactionInfoTemplate": { + "$ref": "TransactionInfo", + "description": "[Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one." + } + }, + "type": "object" + }, + "JobStatistics2": { + "id": "JobStatistics2", + "properties": { + "billingTier": { + "description": "[Output-only] Billing tier for the job.", + "format": "int32", + "type": "integer" + }, + "cacheHit": { + "description": "[Output-only] Whether the query result was fetched from the query cache.", + "type": "boolean" + }, + "ddlAffectedRowAccessPolicyCount": { + "description": "[Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.", + "format": "int64", + "type": "string" + }, + "ddlOperationPerformed": { + "description": "The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): \"CREATE\": The query created the DDL target. \"SKIP\": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. \"REPLACE\": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. \"DROP\": The query deleted the DDL target.", + "type": "string" + }, + "ddlTargetDataset": { + "$ref": "DatasetReference", + "description": "[Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries." + }, + "ddlTargetRoutine": { + "$ref": "RoutineReference", + "description": "The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries." + }, + "ddlTargetRowAccessPolicy": { + "$ref": "RowAccessPolicyReference", + "description": "[Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries." + }, + "ddlTargetTable": { + "$ref": "TableReference", + "description": "[Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries." + }, + "estimatedBytesProcessed": { + "description": "[Output-only] The original estimate of bytes processed for the job.", + "format": "int64", + "type": "string" + }, + "modelTraining": { + "$ref": "BigQueryModelTraining", + "description": "[Output-only, Beta] Information about create model query job progress." + }, + "modelTrainingCurrentIteration": { + "description": "[Output-only, Beta] Deprecated; do not use.", + "format": "int32", + "type": "integer" + }, + "modelTrainingExpectedTotalIteration": { + "description": "[Output-only, Beta] Deprecated; do not use.", + "format": "int64", + "type": "string" + }, + "numDmlAffectedRows": { + "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.", + "format": "int64", + "type": "string" + }, + "queryPlan": { + "description": "[Output-only] Describes execution plan for the query.", + "items": { + "$ref": "ExplainQueryStage" + }, + "type": "array" + }, + "referencedRoutines": { + "description": "[Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.", + "items": { + "$ref": "RoutineReference" + }, + "type": "array" + }, + "referencedTables": { + "description": "[Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.", + "items": { + "$ref": "TableReference" + }, + "type": "array" + }, + "reservationUsage": { + "description": "[Output-only] Job resource usage breakdown by reservation.", + "items": { + "properties": { + "name": { + "description": "[Output-only] Reservation name or \"unreserved\" for on-demand resources usage.", + "type": "string" + }, + "slotMs": { + "description": "[Output-only] Slot-milliseconds the job spent in the given reservation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "schema": { + "$ref": "TableSchema", + "description": "[Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries." + }, + "statementType": { + "description": "The type of query statement, if valid. Possible values (new values might be added in the future): \"SELECT\": SELECT query. \"INSERT\": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"UPDATE\": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"DELETE\": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"MERGE\": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"ALTER_TABLE\": ALTER TABLE query. \"ALTER_VIEW\": ALTER VIEW query. \"ASSERT\": ASSERT condition AS 'description'. \"CREATE_FUNCTION\": CREATE FUNCTION query. \"CREATE_MODEL\": CREATE [OR REPLACE] MODEL ... AS SELECT ... . \"CREATE_PROCEDURE\": CREATE PROCEDURE query. \"CREATE_TABLE\": CREATE [OR REPLACE] TABLE without AS SELECT. \"CREATE_TABLE_AS_SELECT\": CREATE [OR REPLACE] TABLE ... AS SELECT ... . \"CREATE_VIEW\": CREATE [OR REPLACE] VIEW ... AS SELECT ... . \"DROP_FUNCTION\" : DROP FUNCTION query. \"DROP_PROCEDURE\": DROP PROCEDURE query. \"DROP_TABLE\": DROP TABLE query. \"DROP_VIEW\": DROP VIEW query.", + "type": "string" + }, + "timeline": { + "description": "[Output-only] [Beta] Describes a timeline of job execution.", + "items": { + "$ref": "QueryTimelineSample" + }, + "type": "array" + }, + "totalBytesBilled": { + "description": "[Output-only] Total bytes billed for the job.", + "format": "int64", + "type": "string" + }, + "totalBytesProcessed": { + "description": "[Output-only] Total bytes processed for the job.", + "format": "int64", + "type": "string" + }, + "totalBytesProcessedAccuracy": { + "description": "[Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.", + "type": "string" + }, + "totalPartitionsProcessed": { + "description": "[Output-only] Total number of partitions processed from all partitioned tables referenced in the job.", + "format": "int64", + "type": "string" + }, + "totalSlotMs": { + "description": "[Output-only] Slot-milliseconds for the job.", + "format": "int64", + "type": "string" + }, + "undeclaredQueryParameters": { + "description": "Standard SQL only: list of undeclared query parameters detected during a dry run validation.", + "items": { + "$ref": "QueryParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "JobStatistics3": { + "id": "JobStatistics3", + "properties": { + "badRecords": { + "description": "[Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.", + "format": "int64", + "type": "string" + }, + "inputFileBytes": { + "description": "[Output-only] Number of bytes of source data in a load job.", + "format": "int64", + "type": "string" + }, + "inputFiles": { + "description": "[Output-only] Number of source files in a load job.", + "format": "int64", + "type": "string" + }, + "outputBytes": { + "description": "[Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.", + "format": "int64", + "type": "string" + }, + "outputRows": { + "description": "[Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "JobStatistics4": { + "id": "JobStatistics4", + "properties": { + "destinationUriFileCounts": { + "description": "[Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "inputBytes": { + "description": "[Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "JobStatus": { + "id": "JobStatus", + "properties": { + "errorResult": { + "$ref": "ErrorProto", + "description": "[Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful." + }, + "errors": { + "description": "[Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "state": { + "description": "[Output-only] Running state of the job.", + "type": "string" + } + }, + "type": "object" + }, + "JsonObject": { + "additionalProperties": { + "$ref": "JsonValue" + }, + "description": "Represents a single JSON object.", + "id": "JsonObject", + "type": "object" + }, + "JsonValue": { + "id": "JsonValue", + "type": "any" + }, + "ListModelsResponse": { + "id": "ListModelsResponse", + "properties": { + "models": { + "description": "Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.", + "items": { + "$ref": "Model" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListRoutinesResponse": { + "id": "ListRoutinesResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "routines": { + "description": "Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.", + "items": { + "$ref": "Routine" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRowAccessPoliciesResponse": { + "description": "Response message for the ListRowAccessPolicies method.", + "id": "ListRowAccessPoliciesResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "rowAccessPolicies": { + "description": "Row access policies on the requested table.", + "items": { + "$ref": "RowAccessPolicy" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationMetadata": { + "description": "BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.", + "id": "LocationMetadata", + "properties": { + "legacyLocationId": { + "description": "The legacy BigQuery location ID, e.g. \u201cEU\u201d for the \u201ceurope\u201d location. This is for any API consumers that need the legacy \u201cUS\u201d and \u201cEU\u201d locations.", + "type": "string" + } + }, + "type": "object" + }, + "MaterializedViewDefinition": { + "id": "MaterializedViewDefinition", + "properties": { + "enableRefresh": { + "description": "[Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is \"true\".", + "type": "boolean" + }, + "lastRefreshTime": { + "description": "[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "query": { + "description": "[Required] A query whose result is persisted.", + "type": "string" + }, + "refreshIntervalMs": { + "description": "[Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is \"1800000\" (30 minutes).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Model": { + "id": "Model", + "properties": { + "bestTrialId": { + "description": "The best trial_id across all training runs.", + "format": "int64", + "type": "string" + }, + "creationTime": { + "description": "Output only. The time when this model was created, in millisecs since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A user-friendly description of this model.", + "type": "string" + }, + "encryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model." + }, + "etag": { + "description": "Output only. A hash of this resource.", + "readOnly": true, + "type": "string" + }, + "expirationTime": { + "description": "Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.", + "format": "int64", + "type": "string" + }, + "featureColumns": { + "description": "Output only. Input feature columns that were used to train this model.", + "items": { + "$ref": "StandardSqlField" + }, + "readOnly": true, + "type": "array" + }, + "friendlyName": { + "description": "Optional. A descriptive name for this model.", + "type": "string" + }, + "labelColumns": { + "description": "Output only. Label columns that were used to train this model. The output of the model will have a \"predicted_\" prefix to these columns.", + "items": { + "$ref": "StandardSqlField" + }, + "readOnly": true, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "lastModifiedTime": { + "description": "Output only. The time when this model was last modified, in millisecs since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Output only. The geographic location where the model resides. This value is inherited from the dataset.", + "readOnly": true, + "type": "string" + }, + "modelReference": { + "$ref": "ModelReference", + "description": "Required. Unique identifier for this model." + }, + "modelType": { + "description": "Output only. Type of the model resource.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "LINEAR_REGRESSION", + "LOGISTIC_REGRESSION", + "KMEANS", + "MATRIX_FACTORIZATION", + "DNN_CLASSIFIER", + "TENSORFLOW", + "DNN_REGRESSOR", + "BOOSTED_TREE_REGRESSOR", + "BOOSTED_TREE_CLASSIFIER", + "ARIMA", + "AUTOML_REGRESSOR", + "AUTOML_CLASSIFIER", + "ARIMA_PLUS" + ], + "enumDescriptions": [ + "", + "Linear regression model.", + "Logistic regression based classification model.", + "K-means clustering model.", + "Matrix factorization model.", + "DNN classifier model.", + "An imported TensorFlow model.", + "DNN regressor model.", + "Boosted tree regressor model.", + "Boosted tree classifier model.", + "ARIMA model.", + "[Beta] AutoML Tables regression model.", + "[Beta] AutoML Tables classification model.", + "New name for the ARIMA model." + ], + "readOnly": true, + "type": "string" + }, + "trainingRuns": { + "description": "Output only. Information for all training runs in increasing order of start_time.", + "items": { + "$ref": "TrainingRun" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ModelDefinition": { + "id": "ModelDefinition", + "properties": { + "modelOptions": { + "description": "[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.", + "properties": { + "labels": { + "items": { + "type": "string" + }, + "type": "array" + }, + "lossType": { + "type": "string" + }, + "modelType": { + "type": "string" + } + }, + "type": "object" + }, + "trainingRuns": { + "description": "[Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.", + "items": { + "$ref": "BqmlTrainingRun" + }, + "type": "array" + } + }, + "type": "object" + }, + "ModelReference": { + "id": "ModelReference", + "properties": { + "datasetId": { + "description": "[Required] The ID of the dataset containing this model.", + "type": "string" + }, + "modelId": { + "description": "[Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.", + "type": "string" + }, + "projectId": { + "description": "[Required] The ID of the project containing this model.", + "type": "string" + } + }, + "type": "object" + }, + "MultiClassClassificationMetrics": { + "description": "Evaluation metrics for multi-class classification/classifier models.", + "id": "MultiClassClassificationMetrics", + "properties": { + "aggregateClassificationMetrics": { + "$ref": "AggregateClassificationMetrics", + "description": "Aggregate classification metrics." + }, + "confusionMatrixList": { + "description": "Confusion matrix at different thresholds.", + "items": { + "$ref": "ConfusionMatrix" + }, + "type": "array" + } + }, + "type": "object" + }, + "ParquetOptions": { + "id": "ParquetOptions", + "properties": { + "enableListInference": { + "description": "[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.", + "type": "boolean" + }, + "enumAsString": { + "description": "[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.", + "type": "boolean" + } + }, + "type": "object" + }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ProjectList": { + "id": "ProjectList", + "properties": { + "etag": { + "description": "A hash of the page of results", + "type": "string" + }, + "kind": { + "default": "bigquery#projectList", + "description": "The type of list.", + "type": "string" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "projects": { + "description": "Projects to which you have at least READ access.", + "items": { + "properties": { + "friendlyName": { + "description": "A descriptive name for this project.", + "type": "string" + }, + "id": { + "description": "An opaque ID of this project.", + "type": "string" + }, + "kind": { + "default": "bigquery#project", + "description": "The resource type.", + "type": "string" + }, + "numericId": { + "description": "The numeric ID of this project.", + "format": "uint64", + "type": "string" + }, + "projectReference": { + "$ref": "ProjectReference", + "description": "A unique reference to this project." + } + }, + "type": "object" + }, + "type": "array" + }, + "totalItems": { + "description": "The total number of projects in the list.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ProjectReference": { + "id": "ProjectReference", + "properties": { + "projectId": { + "description": "[Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.", + "type": "string" + } + }, + "type": "object" + }, + "QueryParameter": { + "id": "QueryParameter", + "properties": { + "name": { + "description": "[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.", + "type": "string" + }, + "parameterType": { + "$ref": "QueryParameterType", + "description": "[Required] The type of this parameter." + }, + "parameterValue": { + "$ref": "QueryParameterValue", + "description": "[Required] The value of this parameter." + } + }, + "type": "object" + }, + "QueryParameterType": { + "id": "QueryParameterType", + "properties": { + "arrayType": { + "$ref": "QueryParameterType", + "description": "[Optional] The type of the array's elements, if this is an array." + }, + "structTypes": { + "description": "[Optional] The types of the fields of this struct, in order, if this is a struct.", + "items": { + "properties": { + "description": { + "description": "[Optional] Human-oriented description of the field.", + "type": "string" + }, + "name": { + "description": "[Optional] The name of this field.", + "type": "string" + }, + "type": { + "$ref": "QueryParameterType", + "description": "[Required] The type of this field." + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "[Required] The top level type of this field.", + "type": "string" + } + }, + "type": "object" + }, + "QueryParameterValue": { + "id": "QueryParameterValue", + "properties": { + "arrayValues": { + "description": "[Optional] The array values, if this is an array type.", + "items": { + "$ref": "QueryParameterValue" + }, + "type": "array" + }, + "structValues": { + "additionalProperties": { + "$ref": "QueryParameterValue" + }, + "description": "[Optional] The struct field values, in order of the struct type's declaration.", + "type": "object" + }, + "value": { + "description": "[Optional] The value of this value, if a simple scalar type.", + "type": "string" + } + }, + "type": "object" + }, + "QueryRequest": { + "id": "QueryRequest", + "properties": { + "connectionProperties": { + "description": "Connection properties.", + "items": { + "$ref": "ConnectionProperty" + }, + "type": "array" + }, + "createSession": { + "description": "If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.", + "type": "boolean" + }, + "defaultDataset": { + "$ref": "DatasetReference", + "description": "[Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'." + }, + "dryRun": { + "description": "[Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.", + "type": "boolean" + }, + "kind": { + "default": "bigquery#queryRequest", + "description": "The resource type of the request.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "location": { + "description": "The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "type": "string" + }, + "maxResults": { + "description": "[Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.", + "format": "uint32", + "type": "integer" + }, + "maximumBytesBilled": { + "description": "[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.", + "format": "int64", + "type": "string" + }, + "parameterMode": { + "description": "Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.", + "type": "string" + }, + "preserveNulls": { + "description": "[Deprecated] This property is deprecated.", + "type": "boolean" + }, + "query": { + "annotations": { + "required": [ + "bigquery.jobs.query" + ] + }, + "description": "[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: \"SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]\".", + "type": "string" + }, + "queryParameters": { + "description": "Query parameters for Standard SQL queries.", + "items": { + "$ref": "QueryParameter" + }, + "type": "array" + }, + "requestId": { + "description": "A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of the previous request, all parameters in the request that may affect the behavior are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.", + "type": "string" + }, + "timeoutMs": { + "description": "[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).", + "format": "uint32", + "type": "integer" + }, + "useLegacySql": { + "default": "true", + "description": "Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.", + "type": "boolean" + }, + "useQueryCache": { + "default": "true", + "description": "[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.", + "type": "boolean" + } + }, + "type": "object" + }, + "QueryResponse": { + "id": "QueryResponse", + "properties": { + "cacheHit": { + "description": "Whether the query result was fetched from the query cache.", + "type": "boolean" + }, + "errors": { + "description": "[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "jobComplete": { + "description": "Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.", + "type": "boolean" + }, + "jobReference": { + "$ref": "JobReference", + "description": "Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults)." + }, + "kind": { + "default": "bigquery#queryResponse", + "description": "The resource type.", + "type": "string" + }, + "numDmlAffectedRows": { + "description": "[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.", + "format": "int64", + "type": "string" + }, + "pageToken": { + "description": "A token used for paging results.", + "type": "string" + }, + "rows": { + "description": "An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.", + "items": { + "$ref": "TableRow" + }, + "type": "array" + }, + "schema": { + "$ref": "TableSchema", + "description": "The schema of the results. Present only when the query completes successfully." + }, + "sessionInfoTemplate": { + "$ref": "SessionInfo", + "description": "[Output-only] [Preview] Information of the session if this job is part of one." + }, + "totalBytesProcessed": { + "description": "The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.", + "format": "int64", + "type": "string" + }, + "totalRows": { + "description": "The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "QueryTimelineSample": { + "id": "QueryTimelineSample", + "properties": { + "activeUnits": { + "description": "Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.", + "format": "int64", + "type": "string" + }, + "completedUnits": { + "description": "Total parallel units of work completed by this query.", + "format": "int64", + "type": "string" + }, + "elapsedMs": { + "description": "Milliseconds elapsed since the start of query execution.", + "format": "int64", + "type": "string" + }, + "pendingUnits": { + "description": "Total parallel units of work remaining for the active stages.", + "format": "int64", + "type": "string" + }, + "totalSlotMs": { + "description": "Cumulative slot-ms consumed by the query.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RangePartitioning": { + "id": "RangePartitioning", + "properties": { + "field": { + "description": "[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.", + "type": "string" + }, + "range": { + "description": "[TrustedTester] [Required] Defines the ranges for range partitioning.", + "properties": { + "end": { + "description": "[TrustedTester] [Required] The end of range partitioning, exclusive.", + "format": "int64", + "type": "string" + }, + "interval": { + "description": "[TrustedTester] [Required] The width of each interval.", + "format": "int64", + "type": "string" + }, + "start": { + "description": "[TrustedTester] [Required] The start of range partitioning, inclusive.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RankingMetrics": { + "description": "Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit.", + "id": "RankingMetrics", + "properties": { + "averageRank": { + "description": "Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.", + "format": "double", + "type": "number" + }, + "meanAveragePrecision": { + "description": "Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.", + "format": "double", + "type": "number" + }, + "meanSquaredError": { + "description": "Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.", + "format": "double", + "type": "number" + }, + "normalizedDiscountedCumulativeGain": { + "description": "A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "RegressionMetrics": { + "description": "Evaluation metrics for regression and explicit feedback type matrix factorization models.", + "id": "RegressionMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean absolute error.", + "format": "double", + "type": "number" + }, + "meanSquaredError": { + "description": "Mean squared error.", + "format": "double", + "type": "number" + }, + "meanSquaredLogError": { + "description": "Mean squared log error.", + "format": "double", + "type": "number" + }, + "medianAbsoluteError": { + "description": "Median absolute error.", + "format": "double", + "type": "number" + }, + "rSquared": { + "description": "R^2 score. This corresponds to r2_score in ML.EVALUATE.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Routine": { + "description": "A user-defined function or a stored procedure.", + "id": "Routine", + "properties": { + "arguments": { + "description": "Optional.", + "items": { + "$ref": "Argument" + }, + "type": "array" + }, + "creationTime": { + "description": "Output only. The time when this routine was created, in milliseconds since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "definitionBody": { + "description": "Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, \"\\n\", y))` The definition_body is `concat(x, \"\\n\", y)` (\\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return \"\\n\";\\n'` The definition_body is `return \"\\n\";\\n` Note that both \\n are replaced with linebreaks.", + "type": "string" + }, + "description": { + "description": "Optional. [Experimental] The description of the routine if defined.", + "type": "string" + }, + "determinismLevel": { + "description": "Optional. [Experimental] The determinism level of the JavaScript UDF if defined.", + "enum": [ + "DETERMINISM_LEVEL_UNSPECIFIED", + "DETERMINISTIC", + "NOT_DETERMINISTIC" + ], + "enumDescriptions": [ + "The determinism of the UDF is unspecified.", + "The UDF is deterministic, meaning that 2 function calls with the same inputs always produce the same result, even across 2 query runs.", + "The UDF is not deterministic." + ], + "type": "string" + }, + "etag": { + "description": "Output only. A hash of this resource.", + "readOnly": true, + "type": "string" + }, + "importedLibraries": { + "description": "Optional. If language = \"JAVASCRIPT\", this field stores the path of the imported JAVASCRIPT libraries.", + "items": { + "type": "string" + }, + "type": "array" + }, + "language": { + "description": "Optional. Defaults to \"SQL\".", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "SQL", + "JAVASCRIPT" + ], + "enumDescriptions": [ + "", + "SQL language.", + "JavaScript language." + ], + "type": "string" + }, + "lastModifiedTime": { + "description": "Output only. The time when this routine was last modified, in milliseconds since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "returnTableType": { + "$ref": "StandardSqlTableType", + "description": "Optional. Set only if Routine is a \"TABLE_VALUED_FUNCTION\"." + }, + "returnType": { + "$ref": "StandardSqlDataType", + "description": "Optional if language = \"SQL\"; required otherwise. If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: \"FLOAT64\"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64." + }, + "routineReference": { + "$ref": "RoutineReference", + "description": "Required. Reference describing the ID of this routine." + }, + "routineType": { + "description": "Required. The type of routine.", + "enum": [ + "ROUTINE_TYPE_UNSPECIFIED", + "SCALAR_FUNCTION", + "PROCEDURE", + "TABLE_VALUED_FUNCTION" + ], + "enumDescriptions": [ + "", + "Non-builtin permanent scalar function.", + "Stored procedure.", + "Non-builtin permanent TVF." + ], + "type": "string" + } + }, + "type": "object" + }, + "RoutineReference": { + "id": "RoutineReference", + "properties": { + "datasetId": { + "description": "[Required] The ID of the dataset containing this routine.", + "type": "string" + }, + "projectId": { + "description": "[Required] The ID of the project containing this routine.", + "type": "string" + }, + "routineId": { + "description": "[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "Row": { + "description": "A single row in the confusion matrix.", + "id": "Row", + "properties": { + "actualLabel": { + "description": "The original label of this row.", + "type": "string" + }, + "entries": { + "description": "Info describing predicted label distribution.", + "items": { + "$ref": "Entry" + }, + "type": "array" + } + }, + "type": "object" + }, + "RowAccessPolicy": { + "description": "Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.", + "id": "RowAccessPolicy", + "properties": { + "creationTime": { + "description": "Output only. The time when this row access policy was created, in milliseconds since the epoch.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. A hash of this resource.", + "readOnly": true, + "type": "string" + }, + "filterPredicate": { + "description": "Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0", + "type": "string" + }, + "lastModifiedTime": { + "description": "Output only. The time when this row access policy was last modified, in milliseconds since the epoch.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "rowAccessPolicyReference": { + "$ref": "RowAccessPolicyReference", + "description": "Required. Reference describing the ID of this row access policy." + } + }, + "type": "object" + }, + "RowAccessPolicyReference": { + "id": "RowAccessPolicyReference", + "properties": { + "datasetId": { + "description": "[Required] The ID of the dataset containing this row access policy.", + "type": "string" + }, + "policyId": { + "description": "[Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.", + "type": "string" + }, + "projectId": { + "description": "[Required] The ID of the project containing this row access policy.", + "type": "string" + }, + "tableId": { + "description": "[Required] The ID of the table containing this row access policy.", + "type": "string" + } + }, + "type": "object" + }, + "RowLevelSecurityStatistics": { + "id": "RowLevelSecurityStatistics", + "properties": { + "rowLevelSecurityApplied": { + "description": "[Output-only] [Preview] Whether any accessed data was protected by row access policies.", + "type": "boolean" + } + }, + "type": "object" + }, + "ScriptStackFrame": { + "id": "ScriptStackFrame", + "properties": { + "endColumn": { + "description": "[Output-only] One-based end column.", + "format": "int32", + "type": "integer" + }, + "endLine": { + "description": "[Output-only] One-based end line.", + "format": "int32", + "type": "integer" + }, + "procedureId": { + "description": "[Output-only] Name of the active procedure, empty if in a top-level script.", + "type": "string" + }, + "startColumn": { + "description": "[Output-only] One-based start column.", + "format": "int32", + "type": "integer" + }, + "startLine": { + "description": "[Output-only] One-based start line.", + "format": "int32", + "type": "integer" + }, + "text": { + "description": "[Output-only] Text of the current statement/expression.", + "type": "string" + } + }, + "type": "object" + }, + "ScriptStatistics": { + "id": "ScriptStatistics", + "properties": { + "evaluationKind": { + "description": "[Output-only] Whether this child job was a statement or expression.", + "type": "string" + }, + "stackFrames": { + "description": "Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.", + "items": { + "$ref": "ScriptStackFrame" + }, + "type": "array" + } + }, + "type": "object" + }, + "SessionInfo": { + "id": "SessionInfo", + "properties": { + "sessionId": { + "description": "[Output-only] // [Preview] Id of the session.", + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "SnapshotDefinition": { + "id": "SnapshotDefinition", + "properties": { + "baseTableReference": { + "$ref": "TableReference", + "description": "[Required] Reference describing the ID of the table that is snapshotted." + }, + "snapshotTime": { + "description": "[Required] The time at which the base table was snapshot.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "StandardSqlDataType": { + "description": "The type of a variable, e.g., a function argument. Examples: INT64: {type_kind=\"INT64\"} ARRAY: {type_kind=\"ARRAY\", array_element_type=\"STRING\"} STRUCT>: {type_kind=\"STRUCT\", struct_type={fields=[ {name=\"x\", type={type_kind=\"STRING\"}}, {name=\"y\", type={type_kind=\"ARRAY\", array_element_type=\"DATE\"}} ]}}", + "id": "StandardSqlDataType", + "properties": { + "arrayElementType": { + "$ref": "StandardSqlDataType", + "description": "The type of the array's elements, if type_kind = \"ARRAY\"." + }, + "structType": { + "$ref": "StandardSqlStructType", + "description": "The fields of this struct, in order, if type_kind = \"STRUCT\"." + }, + "typeKind": { + "description": "Required. The top level type of this field. Can be any standard SQL data type (e.g., \"INT64\", \"DATE\", \"ARRAY\").", + "enum": [ + "TYPE_KIND_UNSPECIFIED", + "INT64", + "BOOL", + "FLOAT64", + "STRING", + "BYTES", + "TIMESTAMP", + "DATE", + "TIME", + "DATETIME", + "INTERVAL", + "GEOGRAPHY", + "NUMERIC", + "BIGNUMERIC", + "ARRAY", + "STRUCT" + ], + "enumDescriptions": [ + "Invalid type.", + "Encoded as a string in decimal format.", + "Encoded as a boolean \"false\" or \"true\".", + "Encoded as a number, or string \"NaN\", \"Infinity\" or \"-Infinity\".", + "Encoded as a string value.", + "Encoded as a base64 string per RFC 4648, section 4.", + "Encoded as an RFC 3339 timestamp with mandatory \"Z\" time zone string: 1985-04-12T23:20:50.52Z", + "Encoded as RFC 3339 full-date format string: 1985-04-12", + "Encoded as RFC 3339 partial-time format string: 23:20:50.52", + "Encoded as RFC 3339 full-date \"T\" partial-time: 1985-04-12T23:20:50.52", + "Encoded as fully qualified 3 part: 0-5 15 2:30:45.6", + "Encoded as WKT", + "Encoded as a decimal string.", + "Encoded as a decimal string.", + "Encoded as a list with types matching Type.array_type.", + "Encoded as a list with fields of type Type.struct_type[i]. List is used because a JSON object cannot have duplicate field names." + ], + "type": "string" + } + }, + "type": "object" + }, + "StandardSqlField": { + "description": "A field or a column.", + "id": "StandardSqlField", + "properties": { + "name": { + "description": "Optional. The name of this field. Can be absent for struct fields.", + "type": "string" + }, + "type": { + "$ref": "StandardSqlDataType", + "description": "Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this \"type\" field)." + } + }, + "type": "object" + }, + "StandardSqlStructType": { + "id": "StandardSqlStructType", + "properties": { + "fields": { + "items": { + "$ref": "StandardSqlField" + }, + "type": "array" + } + }, + "type": "object" + }, + "StandardSqlTableType": { + "description": "A table type", + "id": "StandardSqlTableType", + "properties": { + "columns": { + "description": "The columns in this table type", + "items": { + "$ref": "StandardSqlField" + }, + "type": "array" + } + }, + "type": "object" + }, + "Streamingbuffer": { + "id": "Streamingbuffer", + "properties": { + "estimatedBytes": { + "description": "[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.", + "format": "uint64", + "type": "string" + }, + "estimatedRows": { + "description": "[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.", + "format": "uint64", + "type": "string" + }, + "oldestEntryTime": { + "description": "[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "Table": { + "id": "Table", + "properties": { + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered." + }, + "creationTime": { + "description": "[Output-only] The time when this table was created, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "[Optional] A user-friendly description of this table.", + "type": "string" + }, + "encryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Custom encryption configuration (e.g., Cloud KMS keys)." + }, + "etag": { + "description": "[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.", + "type": "string" + }, + "expirationTime": { + "description": "[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.", + "format": "int64", + "type": "string" + }, + "externalDataConfiguration": { + "$ref": "ExternalDataConfiguration", + "description": "[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table." + }, + "friendlyName": { + "description": "[Optional] A descriptive name for this table.", + "type": "string" + }, + "id": { + "description": "[Output-only] An opaque ID uniquely identifying the table.", + "type": "string" + }, + "kind": { + "default": "bigquery#table", + "description": "[Output-only] The type of the resource.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.", + "type": "object" + }, + "lastModifiedTime": { + "description": "[Output-only] The time when this table was last modified, in milliseconds since the epoch.", + "format": "uint64", + "type": "string" + }, + "location": { + "description": "[Output-only] The geographic location where the table resides. This value is inherited from the dataset.", + "type": "string" + }, + "materializedView": { + "$ref": "MaterializedViewDefinition", + "description": "[Optional] Materialized view definition." + }, + "model": { + "$ref": "ModelDefinition", + "description": "[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries." + }, + "numBytes": { + "description": "[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.", + "format": "int64", + "type": "string" + }, + "numLongTermBytes": { + "description": "[Output-only] The number of bytes in the table that are considered \"long-term storage\".", + "format": "int64", + "type": "string" + }, + "numPhysicalBytes": { + "description": "[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.", + "format": "int64", + "type": "string" + }, + "numRows": { + "description": "[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.", + "format": "uint64", + "type": "string" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "requirePartitionFilter": { + "default": "false", + "description": "[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.", + "type": "boolean" + }, + "schema": { + "$ref": "TableSchema", + "description": "[Optional] Describes the schema of this table." + }, + "selfLink": { + "description": "[Output-only] A URL that can be used to access this resource again.", + "type": "string" + }, + "snapshotDefinition": { + "$ref": "SnapshotDefinition", + "description": "[Output-only] Snapshot definition." + }, + "streamingBuffer": { + "$ref": "Streamingbuffer", + "description": "[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer." + }, + "tableReference": { + "$ref": "TableReference", + "description": "[Required] Reference describing the ID of this table." + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." + }, + "type": { + "description": "[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.", + "type": "string" + }, + "view": { + "$ref": "ViewDefinition", + "description": "[Optional] The view definition." + } + }, + "type": "object" + }, + "TableCell": { + "id": "TableCell", + "properties": { + "v": { + "type": "any" + } + }, + "type": "object" + }, + "TableDataInsertAllRequest": { + "id": "TableDataInsertAllRequest", + "properties": { + "ignoreUnknownValues": { + "description": "[Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.", + "type": "boolean" + }, + "kind": { + "default": "bigquery#tableDataInsertAllRequest", + "description": "The resource type of the response.", + "type": "string" + }, + "rows": { + "description": "The rows to insert.", + "items": { + "properties": { + "insertId": { + "description": "[Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.", + "type": "string" + }, + "json": { + "$ref": "JsonObject", + "description": "[Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema." + } + }, + "type": "object" + }, + "type": "array" + }, + "skipInvalidRows": { + "description": "[Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.", + "type": "boolean" + }, + "templateSuffix": { + "description": "If specified, treats the destination table as a base template, and inserts the rows into an instance table named \"{destination}{templateSuffix}\". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.", + "type": "string" + } + }, + "type": "object" + }, + "TableDataInsertAllResponse": { + "id": "TableDataInsertAllResponse", + "properties": { + "insertErrors": { + "description": "An array of errors for rows that were not inserted.", + "items": { + "properties": { + "errors": { + "description": "Error information for the row indicated by the index property.", + "items": { + "$ref": "ErrorProto" + }, + "type": "array" + }, + "index": { + "description": "The index of the row that error applies to.", + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "kind": { + "default": "bigquery#tableDataInsertAllResponse", + "description": "The resource type of the response.", + "type": "string" + } + }, + "type": "object" + }, + "TableDataList": { + "id": "TableDataList", + "properties": { + "etag": { + "description": "A hash of this page of results.", + "type": "string" + }, + "kind": { + "default": "bigquery#tableDataList", + "description": "The resource type of the response.", + "type": "string" + }, + "pageToken": { + "description": "A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.", + "type": "string" + }, + "rows": { + "description": "Rows of results.", + "items": { + "$ref": "TableRow" + }, + "type": "array" + }, + "totalRows": { + "description": "The total number of rows in the complete table.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "TableFieldSchema": { + "id": "TableFieldSchema", + "properties": { + "categories": { + "description": "[Optional] The categories attached to this field, used for field-level access control.", + "properties": { + "names": { + "description": "A list of category resource names. For example, \"projects/1/taxonomies/2/categories/3\". At most 5 categories are allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "description": { + "description": "[Optional] The field description. The maximum length is 1,024 characters.", + "type": "string" + }, + "fields": { + "description": "[Optional] Describes the nested schema fields if the type property is set to RECORD.", + "items": { + "$ref": "TableFieldSchema" + }, + "type": "array" + }, + "maxLength": { + "description": "[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = \"STRING\", then max_length represents the maximum UTF-8 length of strings in this field. If type = \"BYTES\", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type \u2260 \"STRING\" and \u2260 \"BYTES\".", + "format": "int64", + "type": "string" + }, + "mode": { + "description": "[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.", + "type": "string" + }, + "name": { + "description": "[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.", + "type": "string" + }, + "policyTags": { + "properties": { + "names": { + "description": "A list of category resource names. For example, \"projects/1/location/eu/taxonomies/2/policyTags/3\". At most 1 policy tag is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "precision": { + "description": "[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type \u2260 \"NUMERIC\" and \u2260 \"BIGNUMERIC\". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = \"NUMERIC\": 1 \u2264 precision - scale \u2264 29 and 0 \u2264 scale \u2264 9. - If type = \"BIGNUMERIC\": 1 \u2264 precision - scale \u2264 38 and 0 \u2264 scale \u2264 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = \"NUMERIC\": 1 \u2264 precision \u2264 29. - If type = \"BIGNUMERIC\": 1 \u2264 precision \u2264 38. If scale is specified but not precision, then it is invalid.", + "format": "int64", + "type": "string" + }, + "scale": { + "description": "[Optional] See documentation for precision.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).", + "type": "string" + } + }, + "type": "object" + }, + "TableList": { + "id": "TableList", + "properties": { + "etag": { + "description": "A hash of this page of results.", + "type": "string" + }, + "kind": { + "default": "bigquery#tableList", + "description": "The type of list.", + "type": "string" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "tables": { + "description": "Tables in the requested dataset.", + "items": { + "properties": { + "clustering": { + "$ref": "Clustering", + "description": "[Beta] Clustering specification for this table, if configured." + }, + "creationTime": { + "description": "The time when this table was created, in milliseconds since the epoch.", + "format": "int64", + "type": "string" + }, + "expirationTime": { + "description": "[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.", + "format": "int64", + "type": "string" + }, + "friendlyName": { + "description": "The user-friendly name for this table.", + "type": "string" + }, + "id": { + "description": "An opaque ID of the table", + "type": "string" + }, + "kind": { + "default": "bigquery#table", + "description": "The resource type.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this table. You can use these to organize and group your tables.", + "type": "object" + }, + "rangePartitioning": { + "$ref": "RangePartitioning", + "description": "The range partitioning specification for this table, if configured." + }, + "tableReference": { + "$ref": "TableReference", + "description": "A reference uniquely identifying the table." + }, + "timePartitioning": { + "$ref": "TimePartitioning", + "description": "The time-based partitioning specification for this table, if configured." + }, + "type": { + "description": "The type of table. Possible values are: TABLE, VIEW.", + "type": "string" + }, + "view": { + "description": "Additional details for a view.", + "properties": { + "useLegacySql": { + "description": "True if view is defined in legacy SQL dialect, false if in standard SQL.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + }, + "totalItems": { + "description": "The total number of tables in the dataset.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TableReference": { + "id": "TableReference", + "properties": { + "datasetId": { + "annotations": { + "required": [ + "bigquery.tables.update" + ] + }, + "description": "[Required] The ID of the dataset containing this table.", + "type": "string" + }, + "projectId": { + "annotations": { + "required": [ + "bigquery.tables.update" + ] + }, + "description": "[Required] The ID of the project containing this table.", + "type": "string" + }, + "tableId": { + "annotations": { + "required": [ + "bigquery.tables.update" + ] + }, + "description": "[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "TableRow": { + "id": "TableRow", + "properties": { + "f": { + "description": "Represents a single row in the result set, consisting of one or more fields.", + "items": { + "$ref": "TableCell" + }, + "type": "array" + } + }, + "type": "object" + }, + "TableSchema": { + "id": "TableSchema", + "properties": { + "fields": { + "description": "Describes the fields in a table.", + "items": { + "$ref": "TableFieldSchema" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TimePartitioning": { + "id": "TimePartitioning", + "properties": { + "expirationMs": { + "description": "[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.", + "format": "int64", + "type": "string" + }, + "field": { + "description": "[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.", + "type": "string" + }, + "requirePartitionFilter": { + "type": "boolean" + }, + "type": { + "description": "[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.", + "type": "string" + } + }, + "type": "object" + }, + "TrainingOptions": { + "description": "Options used in model training.", + "id": "TrainingOptions", + "properties": { + "adjustStepChanges": { + "description": "If true, detect step changes and make data adjustment in the input time series.", + "type": "boolean" + }, + "autoArima": { + "description": "Whether to enable auto ARIMA or not.", + "type": "boolean" + }, + "autoArimaMaxOrder": { + "description": "The max value of non-seasonal p and q.", + "format": "int64", + "type": "string" + }, + "batchSize": { + "description": "Batch size for dnn models.", + "format": "int64", + "type": "string" + }, + "cleanSpikesAndDips": { + "description": "If true, clean spikes and dips in the input time series.", + "type": "boolean" + }, + "dataFrequency": { + "description": "The data frequency of a time series.", + "enum": [ + "DATA_FREQUENCY_UNSPECIFIED", + "AUTO_FREQUENCY", + "YEARLY", + "QUARTERLY", + "MONTHLY", + "WEEKLY", + "DAILY", + "HOURLY", + "PER_MINUTE" + ], + "enumDescriptions": [ + "", + "Automatically inferred from timestamps.", + "Yearly data.", + "Quarterly data.", + "Monthly data.", + "Weekly data.", + "Daily data.", + "Hourly data.", + "Per-minute data." + ], + "type": "string" + }, + "dataSplitColumn": { + "description": "The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties", + "type": "string" + }, + "dataSplitEvalFraction": { + "description": "The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.", + "format": "double", + "type": "number" + }, + "dataSplitMethod": { + "description": "The data split type for training and evaluation, e.g. RANDOM.", + "enum": [ + "DATA_SPLIT_METHOD_UNSPECIFIED", + "RANDOM", + "CUSTOM", + "SEQUENTIAL", + "NO_SPLIT", + "AUTO_SPLIT" + ], + "enumDescriptions": [ + "", + "Splits data randomly.", + "Splits data with the user provided tags.", + "Splits data sequentially.", + "Data split will be skipped.", + "Splits data automatically: Uses NO_SPLIT if the data size is small. Otherwise uses RANDOM." + ], + "type": "string" + }, + "decomposeTimeSeries": { + "description": "If true, perform decompose time series and save the results.", + "type": "boolean" + }, + "distanceType": { + "description": "Distance type for clustering models.", + "enum": [ + "DISTANCE_TYPE_UNSPECIFIED", + "EUCLIDEAN", + "COSINE" + ], + "enumDescriptions": [ + "", + "Eculidean distance.", + "Cosine distance." + ], + "type": "string" + }, + "dropout": { + "description": "Dropout probability for dnn models.", + "format": "double", + "type": "number" + }, + "earlyStop": { + "description": "Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.", + "type": "boolean" + }, + "feedbackType": { + "description": "Feedback type that specifies which algorithm to run for matrix factorization.", + "enum": [ + "FEEDBACK_TYPE_UNSPECIFIED", + "IMPLICIT", + "EXPLICIT" + ], + "enumDescriptions": [ + "", + "Use weighted-als for implicit feedback problems.", + "Use nonweighted-als for explicit feedback problems." + ], + "type": "string" + }, + "hiddenUnits": { + "description": "Hidden units for dnn models.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "holidayRegion": { + "description": "The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.", + "enum": [ + "HOLIDAY_REGION_UNSPECIFIED", + "GLOBAL", + "NA", + "JAPAC", + "EMEA", + "LAC", + "AE", + "AR", + "AT", + "AU", + "BE", + "BR", + "CA", + "CH", + "CL", + "CN", + "CO", + "CS", + "CZ", + "DE", + "DK", + "DZ", + "EC", + "EE", + "EG", + "ES", + "FI", + "FR", + "GB", + "GR", + "HK", + "HU", + "ID", + "IE", + "IL", + "IN", + "IR", + "IT", + "JP", + "KR", + "LV", + "MA", + "MX", + "MY", + "NG", + "NL", + "NO", + "NZ", + "PE", + "PH", + "PK", + "PL", + "PT", + "RO", + "RS", + "RU", + "SA", + "SE", + "SG", + "SI", + "SK", + "TH", + "TR", + "TW", + "UA", + "US", + "VE", + "VN", + "ZA" + ], + "enumDescriptions": [ + "Holiday region unspecified.", + "Global.", + "North America.", + "Japan and Asia Pacific: Korea, Greater China, India, Australia, and New Zealand.", + "Europe, the Middle East and Africa.", + "Latin America and the Caribbean.", + "United Arab Emirates", + "Argentina", + "Austria", + "Australia", + "Belgium", + "Brazil", + "Canada", + "Switzerland", + "Chile", + "China", + "Colombia", + "Czechoslovakia", + "Czech Republic", + "Germany", + "Denmark", + "Algeria", + "Ecuador", + "Estonia", + "Egypt", + "Spain", + "Finland", + "France", + "Great Britain (United Kingdom)", + "Greece", + "Hong Kong", + "Hungary", + "Indonesia", + "Ireland", + "Israel", + "India", + "Iran", + "Italy", + "Japan", + "Korea (South)", + "Latvia", + "Morocco", + "Mexico", + "Malaysia", + "Nigeria", + "Netherlands", + "Norway", + "New Zealand", + "Peru", + "Philippines", + "Pakistan", + "Poland", + "Portugal", + "Romania", + "Serbia", + "Russian Federation", + "Saudi Arabia", + "Sweden", + "Singapore", + "Slovenia", + "Slovakia", + "Thailand", + "Turkey", + "Taiwan", + "Ukraine", + "United States", + "Venezuela", + "Viet Nam", + "South Africa" + ], + "type": "string" + }, + "horizon": { + "description": "The number of periods ahead that need to be forecasted.", + "format": "int64", + "type": "string" + }, + "includeDrift": { + "description": "Include drift when fitting an ARIMA model.", + "type": "boolean" + }, + "initialLearnRate": { + "description": "Specifies the initial learning rate for the line search learn rate strategy.", + "format": "double", + "type": "number" + }, + "inputLabelColumns": { + "description": "Name of input label columns in training data.", + "items": { + "type": "string" + }, + "type": "array" + }, + "itemColumn": { + "description": "Item column specified for matrix factorization models.", + "type": "string" + }, + "kmeansInitializationColumn": { + "description": "The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.", + "type": "string" + }, + "kmeansInitializationMethod": { + "description": "The method used to initialize the centroids for kmeans algorithm.", + "enum": [ + "KMEANS_INITIALIZATION_METHOD_UNSPECIFIED", + "RANDOM", + "CUSTOM", + "KMEANS_PLUS_PLUS" + ], + "enumDescriptions": [ + "Unspecified initialization method.", + "Initializes the centroids randomly.", + "Initializes the centroids using data specified in kmeans_initialization_column.", + "Initializes with kmeans++." + ], + "type": "string" + }, + "l1Regularization": { + "description": "L1 regularization coefficient.", + "format": "double", + "type": "number" + }, + "l2Regularization": { + "description": "L2 regularization coefficient.", + "format": "double", + "type": "number" + }, + "labelClassWeights": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.", + "type": "object" + }, + "learnRate": { + "description": "Learning rate in training. Used only for iterative training algorithms.", + "format": "double", + "type": "number" + }, + "learnRateStrategy": { + "description": "The strategy to determine learn rate for the current iteration.", + "enum": [ + "LEARN_RATE_STRATEGY_UNSPECIFIED", + "LINE_SEARCH", + "CONSTANT" + ], + "enumDescriptions": [ + "", + "Use line search to determine learning rate.", + "Use a constant learning rate." + ], + "type": "string" + }, + "lossType": { + "description": "Type of loss function used during training run.", + "enum": [ + "LOSS_TYPE_UNSPECIFIED", + "MEAN_SQUARED_LOSS", + "MEAN_LOG_LOSS" + ], + "enumDescriptions": [ + "", + "Mean squared loss, used for linear regression.", + "Mean log loss, used for logistic regression." + ], + "type": "string" + }, + "maxIterations": { + "description": "The maximum number of iterations in training. Used only for iterative training algorithms.", + "format": "int64", + "type": "string" + }, + "maxTreeDepth": { + "description": "Maximum depth of a tree for boosted tree models.", + "format": "int64", + "type": "string" + }, + "minRelativeProgress": { + "description": "When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.", + "format": "double", + "type": "number" + }, + "minSplitLoss": { + "description": "Minimum split loss for boosted tree models.", + "format": "double", + "type": "number" + }, + "modelUri": { + "description": "Google Cloud Storage URI from which the model was imported. Only applicable for imported models.", + "type": "string" + }, + "nonSeasonalOrder": { + "$ref": "ArimaOrder", + "description": "A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order." + }, + "numClusters": { + "description": "Number of clusters for clustering models.", + "format": "int64", + "type": "string" + }, + "numFactors": { + "description": "Num factors specified for matrix factorization models.", + "format": "int64", + "type": "string" + }, + "optimizationStrategy": { + "description": "Optimization strategy for training linear regression models.", + "enum": [ + "OPTIMIZATION_STRATEGY_UNSPECIFIED", + "BATCH_GRADIENT_DESCENT", + "NORMAL_EQUATION" + ], + "enumDescriptions": [ + "", + "Uses an iterative batch gradient descent algorithm.", + "Uses a normal equation to solve linear regression problem." + ], + "type": "string" + }, + "preserveInputStructs": { + "description": "Whether to preserve the input structs in output feature names. Suppose there is a struct A with field b. When false (default), the output feature name is A_b. When true, the output feature name is A.b.", + "type": "boolean" + }, + "subsample": { + "description": "Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.", + "format": "double", + "type": "number" + }, + "timeSeriesDataColumn": { + "description": "Column to be designated as time series data for ARIMA model.", + "type": "string" + }, + "timeSeriesIdColumn": { + "description": "The time series id column that was used during ARIMA model training.", + "type": "string" + }, + "timeSeriesIdColumns": { + "description": "The time series id columns that were used during ARIMA model training.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeSeriesTimestampColumn": { + "description": "Column to be designated as time series timestamp for ARIMA model.", + "type": "string" + }, + "userColumn": { + "description": "User column specified for matrix factorization models.", + "type": "string" + }, + "walsAlpha": { + "description": "Hyperparameter for matrix factoration when implicit feedback type is specified.", + "format": "double", + "type": "number" + }, + "warmStart": { + "description": "Whether to train a model from the last checkpoint.", + "type": "boolean" + } + }, + "type": "object" + }, + "TrainingRun": { + "description": "Information about a single training query run for the model.", + "id": "TrainingRun", + "properties": { + "dataSplitResult": { + "$ref": "DataSplitResult", + "description": "Data split result of the training run. Only set when the input data is actually split." + }, + "evaluationMetrics": { + "$ref": "EvaluationMetrics", + "description": "The evaluation metrics over training/eval data that were computed at the end of training." + }, + "globalExplanations": { + "description": "Global explanations for important features of the model. For multi-class models, there is one entry for each label class. For other models, there is only one entry in the list.", + "items": { + "$ref": "GlobalExplanation" + }, + "type": "array" + }, + "results": { + "description": "Output of each iteration run, results.size() <= max_iterations.", + "items": { + "$ref": "IterationResult" + }, + "type": "array" + }, + "startTime": { + "description": "The start time of this training run.", + "format": "google-datetime", + "type": "string" + }, + "trainingOptions": { + "$ref": "TrainingOptions", + "description": "Options that were used for this training run, includes user specified and default options that were used." + } + }, + "type": "object" + }, + "TransactionInfo": { + "id": "TransactionInfo", + "properties": { + "transactionId": { + "description": "[Output-only] // [Alpha] Id of the transaction.", + "type": "string" + } + }, + "type": "object" + }, + "UserDefinedFunctionResource": { + "description": "This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions", + "id": "UserDefinedFunctionResource", + "properties": { + "inlineCode": { + "description": "[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.", + "type": "string" + }, + "resourceUri": { + "description": "[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).", + "type": "string" + } + }, + "type": "object" + }, + "ViewDefinition": { + "id": "ViewDefinition", + "properties": { + "query": { + "description": "[Required] A query that BigQuery executes when the view is referenced.", + "type": "string" + }, + "useLegacySql": { + "description": "Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.", + "type": "boolean" + }, + "userDefinedFunctionResources": { + "description": "Describes user-defined function resources used in the query.", + "items": { + "$ref": "UserDefinedFunctionResource" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "bigquery/v2/", + "title": "BigQuery API", + "version": "v2" +} \ No newline at end of file diff --git a/scripts/test_resources/new_artifacts_dir/drive.v3.json b/scripts/test_resources/new_artifacts_dir/drive.v3.json new file mode 100644 index 00000000000..5ac70fe21b4 --- /dev/null +++ b/scripts/test_resources/new_artifacts_dir/drive.v3.json @@ -0,0 +1,3947 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/drive": { + "description": "See, edit, create, and delete all of your Google Drive files" + }, + "https://www.googleapis.com/auth/drive.appdata": { + "description": "See, create, and delete its own configuration data in your Google Drive" + }, + "https://www.googleapis.com/auth/drive.file": { + "description": "See, edit, create, and delete only the specific Google Drive files you use with this app" + }, + "https://www.googleapis.com/auth/drive.metadata": { + "description": "View and manage metadata of files in your Google Drive" + }, + "https://www.googleapis.com/auth/drive.metadata.readonly": { + "description": "See information about your Google Drive files" + }, + "https://www.googleapis.com/auth/drive.photos.readonly": { + "description": "View the photos, videos and albums in your Google Photos" + }, + "https://www.googleapis.com/auth/drive.readonly": { + "description": "See and download all your Google Drive files" + }, + "https://www.googleapis.com/auth/drive.scripts": { + "description": "Modify your Google Apps Script scripts' behavior" + } + } + } + }, + "basePath": "/drive/v3/", + "baseUrl": "https://www.googleapis.com/drive/v3/", + "batchPath": "batch/drive/v3", + "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/Nyk9QooT1-WBB03Ilrr_sA6IsJk\"", + "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" + }, + "id": "drive:v3", + "kind": "discovery#restDescription", + "name": "drive", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "alt": { + "default": "json", + "description": "Data format for the response.", + "enum": [ + "json" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json" + ], + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "userIp": { + "description": "Deprecated. Please use quotaUser instead.", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "about": { + "methods": { + "get": { + "description": "Gets information about the user, the user's Drive, and system capabilities.", + "httpMethod": "GET", + "id": "drive.about.get", + "path": "about", + "response": { + "$ref": "About" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + } + } + }, + "changes": { + "methods": { + "getStartPageToken": { + "description": "Gets the starting pageToken for listing future changes.", + "httpMethod": "GET", + "id": "drive.changes.getStartPageToken", + "parameters": { + "driveId": { + "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "teamDriveId": { + "description": "Deprecated use driveId instead.", + "location": "query", + "type": "string" + } + }, + "path": "changes/startPageToken", + "response": { + "$ref": "StartPageToken" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "list": { + "description": "Lists the changes for a user or shared drive.", + "httpMethod": "GET", + "id": "drive.changes.list", + "parameterOrder": [ + "pageToken" + ], + "parameters": { + "driveId": { + "description": "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.", + "location": "query", + "type": "string" + }, + "includeCorpusRemovals": { + "default": "false", + "description": "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.", + "location": "query", + "type": "boolean" + }, + "includeItemsFromAllDrives": { + "default": "false", + "description": "Whether both My Drive and shared drive items should be included in results.", + "location": "query", + "type": "boolean" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "includeRemoved": { + "default": "true", + "description": "Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.", + "location": "query", + "type": "boolean" + }, + "includeTeamDriveItems": { + "default": "false", + "description": "Deprecated use includeItemsFromAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "pageSize": { + "default": "100", + "description": "The maximum number of changes to return per page.", + "format": "int32", + "location": "query", + "maximum": "1000", + "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 or to the response from the getStartPageToken method.", + "location": "query", + "required": true, + "type": "string" + }, + "restrictToMyDrive": { + "default": "false", + "description": "Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.", + "location": "query", + "type": "boolean" + }, + "spaces": { + "default": "drive", + "description": "A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "teamDriveId": { + "description": "Deprecated use driveId instead.", + "location": "query", + "type": "string" + } + }, + "path": "changes", + "response": { + "$ref": "ChangeList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ], + "supportsSubscription": true + }, + "watch": { + "description": "Subscribes to changes for a user.", + "httpMethod": "POST", + "id": "drive.changes.watch", + "parameterOrder": [ + "pageToken" + ], + "parameters": { + "driveId": { + "description": "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.", + "location": "query", + "type": "string" + }, + "includeCorpusRemovals": { + "default": "false", + "description": "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.", + "location": "query", + "type": "boolean" + }, + "includeItemsFromAllDrives": { + "default": "false", + "description": "Whether both My Drive and shared drive items should be included in results.", + "location": "query", + "type": "boolean" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "includeRemoved": { + "default": "true", + "description": "Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.", + "location": "query", + "type": "boolean" + }, + "includeTeamDriveItems": { + "default": "false", + "description": "Deprecated use includeItemsFromAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "pageSize": { + "default": "100", + "description": "The maximum number of changes to return per page.", + "format": "int32", + "location": "query", + "maximum": "1000", + "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 or to the response from the getStartPageToken method.", + "location": "query", + "required": true, + "type": "string" + }, + "restrictToMyDrive": { + "default": "false", + "description": "Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.", + "location": "query", + "type": "boolean" + }, + "spaces": { + "default": "drive", + "description": "A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "teamDriveId": { + "description": "Deprecated use driveId instead.", + "location": "query", + "type": "string" + } + }, + "path": "changes/watch", + "request": { + "$ref": "Channel", + "parameterName": "resource" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ], + "supportsSubscription": true + } + } + }, + "channels": { + "methods": { + "stop": { + "description": "Stop watching resources through this channel", + "httpMethod": "POST", + "id": "drive.channels.stop", + "path": "channels/stop", + "request": { + "$ref": "Channel", + "parameterName": "resource" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + } + } + }, + "comments": { + "methods": { + "create": { + "description": "Creates a new comment on a file.", + "httpMethod": "POST", + "id": "drive.comments.create", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/comments", + "request": { + "$ref": "Comment" + }, + "response": { + "$ref": "Comment" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "delete": { + "description": "Deletes a comment.", + "httpMethod": "DELETE", + "id": "drive.comments.delete", + "parameterOrder": [ + "fileId", + "commentId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/comments/{commentId}", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "get": { + "description": "Gets a comment by ID.", + "httpMethod": "GET", + "id": "drive.comments.get", + "parameterOrder": [ + "fileId", + "commentId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "includeDeleted": { + "default": "false", + "description": "Whether to return deleted comments. Deleted comments will not include their original content.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/comments/{commentId}", + "response": { + "$ref": "Comment" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "list": { + "description": "Lists a file's comments.", + "httpMethod": "GET", + "id": "drive.comments.list", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "includeDeleted": { + "default": "false", + "description": "Whether to include deleted comments. Deleted comments will not include their original content.", + "location": "query", + "type": "boolean" + }, + "pageSize": { + "default": "20", + "description": "The maximum number of comments to return per page.", + "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" + }, + "startModifiedTime": { + "description": "The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).", + "location": "query", + "type": "string" + } + }, + "path": "files/{fileId}/comments", + "response": { + "$ref": "CommentList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "update": { + "description": "Updates a comment with patch semantics.", + "httpMethod": "PATCH", + "id": "drive.comments.update", + "parameterOrder": [ + "fileId", + "commentId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/comments/{commentId}", + "request": { + "$ref": "Comment" + }, + "response": { + "$ref": "Comment" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + } + } + }, + "drives": { + "methods": { + "create": { + "description": "Creates a new shared drive.", + "httpMethod": "POST", + "id": "drive.drives.create", + "parameterOrder": [ + "requestId" + ], + "parameters": { + "requestId": { + "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", + "location": "query", + "required": true, + "type": "string" + } + }, + "path": "drives", + "request": { + "$ref": "Drive" + }, + "response": { + "$ref": "Drive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "delete": { + "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", + "httpMethod": "DELETE", + "id": "drive.drives.delete", + "parameterOrder": [ + "driveId" + ], + "parameters": { + "driveId": { + "description": "The ID of the shared drive.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "drives/{driveId}", + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "get": { + "description": "Gets a shared drive's metadata by ID.", + "httpMethod": "GET", + "id": "drive.drives.get", + "parameterOrder": [ + "driveId" + ], + "parameters": { + "driveId": { + "description": "The ID of the shared drive.", + "location": "path", + "required": true, + "type": "string" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "drives/{driveId}", + "response": { + "$ref": "Drive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "hide": { + "description": "Hides a shared drive from the default view.", + "httpMethod": "POST", + "id": "drive.drives.hide", + "parameterOrder": [ + "driveId" + ], + "parameters": { + "driveId": { + "description": "The ID of the shared drive.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "drives/{driveId}/hide", + "response": { + "$ref": "Drive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "list": { + "description": "Lists the user's shared drives.", + "httpMethod": "GET", + "id": "drive.drives.list", + "parameters": { + "pageSize": { + "default": "10", + "description": "Maximum number of shared drives to return.", + "format": "int32", + "location": "query", + "maximum": "100", + "minimum": "1", + "type": "integer" + }, + "pageToken": { + "description": "Page token for shared drives.", + "location": "query", + "type": "string" + }, + "q": { + "description": "Query string for searching shared drives.", + "location": "query", + "type": "string" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.", + "location": "query", + "type": "boolean" + } + }, + "path": "drives", + "response": { + "$ref": "DriveList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "unhide": { + "description": "Restores a shared drive to the default view.", + "httpMethod": "POST", + "id": "drive.drives.unhide", + "parameterOrder": [ + "driveId" + ], + "parameters": { + "driveId": { + "description": "The ID of the shared drive.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "drives/{driveId}/unhide", + "response": { + "$ref": "Drive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "update": { + "description": "Updates the metadate for a shared drive.", + "httpMethod": "PATCH", + "id": "drive.drives.update", + "parameterOrder": [ + "driveId" + ], + "parameters": { + "driveId": { + "description": "The ID of the shared drive.", + "location": "path", + "required": true, + "type": "string" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "drives/{driveId}", + "request": { + "$ref": "Drive" + }, + "response": { + "$ref": "Drive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + } + } + }, + "files": { + "methods": { + "copy": { + "description": "Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.", + "httpMethod": "POST", + "id": "drive.files.copy", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "enforceSingleParent": { + "default": "false", + "description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.", + "location": "query", + "type": "boolean" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "ignoreDefaultVisibility": { + "default": "false", + "description": "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.", + "location": "query", + "type": "boolean" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "keepRevisionForever": { + "default": "false", + "description": "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.", + "location": "query", + "type": "boolean" + }, + "ocrLanguage": { + "description": "A language hint for OCR processing during image import (ISO 639-1 code).", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/copy", + "request": { + "$ref": "File" + }, + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.photos.readonly" + ] + }, + "create": { + "description": "Creates a new file.", + "httpMethod": "POST", + "id": "drive.files.create", + "mediaUpload": { + "accept": [ + "*/*" + ], + "maxSize": "5120GB", + "protocols": { + "resumable": { + "multipart": true, + "path": "/resumable/upload/drive/v3/files" + }, + "simple": { + "multipart": true, + "path": "/upload/drive/v3/files" + } + } + }, + "parameters": { + "enforceSingleParent": { + "default": "false", + "description": "Deprecated. Creating files in multiple folders is no longer supported.", + "location": "query", + "type": "boolean" + }, + "ignoreDefaultVisibility": { + "default": "false", + "description": "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.", + "location": "query", + "type": "boolean" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "keepRevisionForever": { + "default": "false", + "description": "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.", + "location": "query", + "type": "boolean" + }, + "ocrLanguage": { + "description": "A language hint for OCR processing during image import (ISO 639-1 code).", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "useContentAsIndexableText": { + "default": "false", + "description": "Whether to use the uploaded content as indexable text.", + "location": "query", + "type": "boolean" + } + }, + "path": "files", + "request": { + "$ref": "File" + }, + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/drive.file" + ], + "supportsMediaUpload": true, + "supportsSubscription": true + }, + "delete": { + "description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.", + "httpMethod": "DELETE", + "id": "drive.files.delete", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "enforceSingleParent": { + "default": "false", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "location": "query", + "type": "boolean" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "emptyTrash": { + "description": "Permanently deletes all of the user's trashed files.", + "httpMethod": "DELETE", + "id": "drive.files.emptyTrash", + "parameters": { + "enforceSingleParent": { + "default": "false", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/trash", + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "export": { + "description": "Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.", + "httpMethod": "GET", + "id": "drive.files.export", + "parameterOrder": [ + "fileId", + "mimeType" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the format requested for this export.", + "location": "query", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/export", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly" + ], + "supportsMediaDownload": true + }, + "generateIds": { + "description": "Generates a set of file IDs which can be provided in create or copy requests.", + "httpMethod": "GET", + "id": "drive.files.generateIds", + "parameters": { + "count": { + "default": "10", + "description": "The number of IDs to return.", + "format": "int32", + "location": "query", + "maximum": "1000", + "minimum": "1", + "type": "integer" + }, + "space": { + "default": "drive", + "description": "The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.", + "location": "query", + "type": "string" + } + }, + "path": "files/generateIds", + "response": { + "$ref": "GeneratedIds" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "get": { + "description": "Gets a file's metadata or content by ID.", + "httpMethod": "GET", + "id": "drive.files.get", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "acknowledgeAbuse": { + "default": "false", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", + "location": "query", + "type": "boolean" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}", + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ], + "supportsMediaDownload": true, + "supportsSubscription": true, + "useMediaDownloadService": true + }, + "list": { + "description": "Lists or searches files.", + "httpMethod": "GET", + "id": "drive.files.list", + "parameters": { + "corpora": { + "description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.", + "location": "query", + "type": "string" + }, + "corpus": { + "description": "The source of files to list. Deprecated: use 'corpora' instead.", + "enum": [ + "domain", + "user" + ], + "enumDescriptions": [ + "Files shared to the user's domain.", + "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." + ], + "location": "query", + "type": "string" + }, + "driveId": { + "description": "ID of the shared drive to search.", + "location": "query", + "type": "string" + }, + "includeItemsFromAllDrives": { + "default": "false", + "description": "Whether both My Drive and shared drive items should be included in results.", + "location": "query", + "type": "boolean" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "includeTeamDriveItems": { + "default": "false", + "description": "Deprecated use includeItemsFromAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "orderBy": { + "description": "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.", + "location": "query", + "type": "string" + }, + "pageSize": { + "default": "100", + "description": "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.", + "format": "int32", + "location": "query", + "maximum": "1000", + "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" + }, + "q": { + "description": "A query for filtering the file results. See the \"Search for Files\" guide for supported syntax.", + "location": "query", + "type": "string" + }, + "spaces": { + "default": "drive", + "description": "A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "teamDriveId": { + "description": "Deprecated use driveId instead.", + "location": "query", + "type": "string" + } + }, + "path": "files", + "response": { + "$ref": "FileList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "update": { + "description": "Updates a file's metadata and/or content. This method supports patch semantics.", + "httpMethod": "PATCH", + "id": "drive.files.update", + "mediaUpload": { + "accept": [ + "*/*" + ], + "maxSize": "5120GB", + "protocols": { + "resumable": { + "multipart": true, + "path": "/resumable/upload/drive/v3/files/{fileId}" + }, + "simple": { + "multipart": true, + "path": "/upload/drive/v3/files/{fileId}" + } + } + }, + "parameterOrder": [ + "fileId" + ], + "parameters": { + "addParents": { + "description": "A comma-separated list of parent IDs to add.", + "location": "query", + "type": "string" + }, + "enforceSingleParent": { + "default": "false", + "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + "location": "query", + "type": "boolean" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "keepRevisionForever": { + "default": "false", + "description": "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.", + "location": "query", + "type": "boolean" + }, + "ocrLanguage": { + "description": "A language hint for OCR processing during image import (ISO 639-1 code).", + "location": "query", + "type": "string" + }, + "removeParents": { + "description": "A comma-separated list of parent IDs to remove.", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "useContentAsIndexableText": { + "default": "false", + "description": "Whether to use the uploaded content as indexable text.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}", + "request": { + "$ref": "File" + }, + "response": { + "$ref": "File" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.metadata", + "https://www.googleapis.com/auth/drive.scripts" + ], + "supportsMediaUpload": true + }, + "watch": { + "description": "Subscribes to changes to a file", + "httpMethod": "POST", + "id": "drive.files.watch", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "acknowledgeAbuse": { + "default": "false", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", + "location": "query", + "type": "boolean" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/watch", + "request": { + "$ref": "Channel", + "parameterName": "resource" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ], + "supportsMediaDownload": true, + "supportsSubscription": true, + "useMediaDownloadService": true + } + } + }, + "permissions": { + "methods": { + "create": { + "description": "Creates a permission for a file or shared drive.", + "httpMethod": "POST", + "id": "drive.permissions.create", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "emailMessage": { + "description": "A plain text custom message to include in the notification email.", + "location": "query", + "type": "string" + }, + "enforceSingleParent": { + "default": "false", + "description": "Deprecated. See moveToNewOwnersRoot for details.", + "location": "query", + "type": "boolean" + }, + "fileId": { + "description": "The ID of the file or shared drive.", + "location": "path", + "required": true, + "type": "string" + }, + "moveToNewOwnersRoot": { + "default": "false", + "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.", + "location": "query", + "type": "boolean" + }, + "sendNotificationEmail": { + "description": "Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.", + "location": "query", + "type": "boolean" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "transferOwnership": { + "default": "false", + "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", + "location": "query", + "type": "boolean" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/permissions", + "request": { + "$ref": "Permission" + }, + "response": { + "$ref": "Permission" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "delete": { + "description": "Deletes a permission.", + "httpMethod": "DELETE", + "id": "drive.permissions.delete", + "parameterOrder": [ + "fileId", + "permissionId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file or shared drive.", + "location": "path", + "required": true, + "type": "string" + }, + "permissionId": { + "description": "The ID of the permission.", + "location": "path", + "required": true, + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/permissions/{permissionId}", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "get": { + "description": "Gets a permission by ID.", + "httpMethod": "GET", + "id": "drive.permissions.get", + "parameterOrder": [ + "fileId", + "permissionId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "permissionId": { + "description": "The ID of the permission.", + "location": "path", + "required": true, + "type": "string" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/permissions/{permissionId}", + "response": { + "$ref": "Permission" + }, + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "list": { + "description": "Lists a file's or shared drive's permissions.", + "httpMethod": "GET", + "id": "drive.permissions.list", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file or shared drive.", + "location": "path", + "required": true, + "type": "string" + }, + "includePermissionsForView": { + "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.", + "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" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/permissions", + "response": { + "$ref": "PermissionList" + }, + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "update": { + "description": "Updates a permission with patch semantics.", + "httpMethod": "PATCH", + "id": "drive.permissions.update", + "parameterOrder": [ + "fileId", + "permissionId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file or shared drive.", + "location": "path", + "required": true, + "type": "string" + }, + "permissionId": { + "description": "The ID of the permission.", + "location": "path", + "required": true, + "type": "string" + }, + "removeExpiration": { + "default": "false", + "description": "Whether to remove the expiration date.", + "location": "query", + "type": "boolean" + }, + "supportsAllDrives": { + "default": "false", + "description": "Whether the requesting application supports both My Drives and shared drives.", + "location": "query", + "type": "boolean" + }, + "supportsTeamDrives": { + "default": "false", + "description": "Deprecated use supportsAllDrives instead.", + "location": "query", + "type": "boolean" + }, + "transferOwnership": { + "default": "false", + "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", + "location": "query", + "type": "boolean" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "files/{fileId}/permissions/{permissionId}", + "request": { + "$ref": "Permission" + }, + "response": { + "$ref": "Permission" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + } + } + }, + "replies": { + "methods": { + "create": { + "description": "Creates a new reply to a comment.", + "httpMethod": "POST", + "id": "drive.replies.create", + "parameterOrder": [ + "fileId", + "commentId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/comments/{commentId}/replies", + "request": { + "$ref": "Reply" + }, + "response": { + "$ref": "Reply" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "delete": { + "description": "Deletes a reply.", + "httpMethod": "DELETE", + "id": "drive.replies.delete", + "parameterOrder": [ + "fileId", + "commentId", + "replyId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "replyId": { + "description": "The ID of the reply.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "get": { + "description": "Gets a reply by ID.", + "httpMethod": "GET", + "id": "drive.replies.get", + "parameterOrder": [ + "fileId", + "commentId", + "replyId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "includeDeleted": { + "default": "false", + "description": "Whether to return deleted replies. Deleted replies will not include their original content.", + "location": "query", + "type": "boolean" + }, + "replyId": { + "description": "The ID of the reply.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + "response": { + "$ref": "Reply" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "list": { + "description": "Lists a comment's replies.", + "httpMethod": "GET", + "id": "drive.replies.list", + "parameterOrder": [ + "fileId", + "commentId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "includeDeleted": { + "default": "false", + "description": "Whether to include deleted replies. Deleted replies will not include their original content.", + "location": "query", + "type": "boolean" + }, + "pageSize": { + "default": "20", + "description": "The maximum number of replies to return per page.", + "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}/comments/{commentId}/replies", + "response": { + "$ref": "ReplyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "update": { + "description": "Updates a reply with patch semantics.", + "httpMethod": "PATCH", + "id": "drive.replies.update", + "parameterOrder": [ + "fileId", + "commentId", + "replyId" + ], + "parameters": { + "commentId": { + "description": "The ID of the comment.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "replyId": { + "description": "The ID of the reply.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/comments/{commentId}/replies/{replyId}", + "request": { + "$ref": "Reply" + }, + "response": { + "$ref": "Reply" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file" + ] + } + } + }, + "revisions": { + "methods": { + "delete": { + "description": "Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.", + "httpMethod": "DELETE", + "id": "drive.revisions.delete", + "parameterOrder": [ + "fileId", + "revisionId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "revisionId": { + "description": "The ID of the revision.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/revisions/{revisionId}", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/drive.file" + ] + }, + "get": { + "description": "Gets a revision's metadata or content by ID.", + "httpMethod": "GET", + "id": "drive.revisions.get", + "parameterOrder": [ + "fileId", + "revisionId" + ], + "parameters": { + "acknowledgeAbuse": { + "default": "false", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", + "location": "query", + "type": "boolean" + }, + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "revisionId": { + "description": "The ID of the revision.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/revisions/{revisionId}", + "response": { + "$ref": "Revision" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ], + "supportsMediaDownload": true, + "useMediaDownloadService": true + }, + "list": { + "description": "Lists a file's revisions.", + "httpMethod": "GET", + "id": "drive.revisions.list", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "default": "200", + "description": "The maximum number of revisions to return per page.", + "format": "int32", + "location": "query", + "maximum": "1000", + "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}/revisions", + "response": { + "$ref": "RevisionList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "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.photos.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "update": { + "description": "Updates a revision with patch semantics.", + "httpMethod": "PATCH", + "id": "drive.revisions.update", + "parameterOrder": [ + "fileId", + "revisionId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "revisionId": { + "description": "The ID of the revision.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/revisions/{revisionId}", + "request": { + "$ref": "Revision" + }, + "response": { + "$ref": "Revision" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/drive.file" + ] + } + } + }, + "teamdrives": { + "methods": { + "create": { + "description": "Deprecated use drives.create instead.", + "httpMethod": "POST", + "id": "drive.teamdrives.create", + "parameterOrder": [ + "requestId" + ], + "parameters": { + "requestId": { + "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", + "location": "query", + "required": true, + "type": "string" + } + }, + "path": "teamdrives", + "request": { + "$ref": "TeamDrive" + }, + "response": { + "$ref": "TeamDrive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "delete": { + "description": "Deprecated use drives.delete instead.", + "httpMethod": "DELETE", + "id": "drive.teamdrives.delete", + "parameterOrder": [ + "teamDriveId" + ], + "parameters": { + "teamDriveId": { + "description": "The ID of the Team Drive", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "teamdrives/{teamDriveId}", + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "get": { + "description": "Deprecated use drives.get instead.", + "httpMethod": "GET", + "id": "drive.teamdrives.get", + "parameterOrder": [ + "teamDriveId" + ], + "parameters": { + "teamDriveId": { + "description": "The ID of the Team Drive", + "location": "path", + "required": true, + "type": "string" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "teamdrives/{teamDriveId}", + "response": { + "$ref": "TeamDrive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "list": { + "description": "Deprecated use drives.list instead.", + "httpMethod": "GET", + "id": "drive.teamdrives.list", + "parameters": { + "pageSize": { + "default": "10", + "description": "Maximum number of Team Drives to return.", + "format": "int32", + "location": "query", + "maximum": "100", + "minimum": "1", + "type": "integer" + }, + "pageToken": { + "description": "Page token for Team Drives.", + "location": "query", + "type": "string" + }, + "q": { + "description": "Query string for searching Team Drives.", + "location": "query", + "type": "string" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.", + "location": "query", + "type": "boolean" + } + }, + "path": "teamdrives", + "response": { + "$ref": "TeamDriveList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "update": { + "description": "Deprecated use drives.update instead", + "httpMethod": "PATCH", + "id": "drive.teamdrives.update", + "parameterOrder": [ + "teamDriveId" + ], + "parameters": { + "teamDriveId": { + "description": "The ID of the Team Drive", + "location": "path", + "required": true, + "type": "string" + }, + "useDomainAdminAccess": { + "default": "false", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.", + "location": "query", + "type": "boolean" + } + }, + "path": "teamdrives/{teamDriveId}", + "request": { + "$ref": "TeamDrive" + }, + "response": { + "$ref": "TeamDrive" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + } + } + } + }, + "revision": "20210322", + "rootUrl": "https://www.googleapis.com/", + "schemas": { + "About": { + "description": "Information about the user, the user's Drive, and system capabilities.", + "id": "About", + "properties": { + "appInstalled": { + "description": "Whether the user has installed the requesting app.", + "type": "boolean" + }, + "canCreateDrives": { + "description": "Whether the user can create shared drives.", + "type": "boolean" + }, + "canCreateTeamDrives": { + "description": "Deprecated - use canCreateDrives instead.", + "type": "boolean" + }, + "driveThemes": { + "description": "A list of themes that are supported for shared drives.", + "items": { + "properties": { + "backgroundImageLink": { + "description": "A link to this theme's background image.", + "type": "string" + }, + "colorRgb": { + "description": "The color of this theme as an RGB hex string.", + "type": "string" + }, + "id": { + "description": "The ID of the theme.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "exportFormats": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "A map of source MIME type to possible targets for all supported exports.", + "type": "object" + }, + "folderColorPalette": { + "description": "The currently supported folder colors as RGB hex strings.", + "items": { + "type": "string" + }, + "type": "array" + }, + "importFormats": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "A map of source MIME type to possible targets for all supported imports.", + "type": "object" + }, + "kind": { + "default": "drive#about", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#about\".", + "type": "string" + }, + "maxImportSizes": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "A map of maximum import sizes by MIME type, in bytes.", + "type": "object" + }, + "maxUploadSize": { + "description": "The maximum upload size in bytes.", + "format": "int64", + "type": "string" + }, + "storageQuota": { + "description": "The user's storage quota limits and usage. All fields are measured in bytes.", + "properties": { + "limit": { + "description": "The usage limit, if applicable. This will not be present if the user has unlimited storage.", + "format": "int64", + "type": "string" + }, + "usage": { + "description": "The total usage across all services.", + "format": "int64", + "type": "string" + }, + "usageInDrive": { + "description": "The usage by all files in Google Drive.", + "format": "int64", + "type": "string" + }, + "usageInDriveTrash": { + "description": "The usage by trashed files in Google Drive.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "teamDriveThemes": { + "description": "Deprecated - use driveThemes instead.", + "items": { + "properties": { + "backgroundImageLink": { + "description": "Deprecated - use driveThemes/backgroundImageLink instead.", + "type": "string" + }, + "colorRgb": { + "description": "Deprecated - use driveThemes/colorRgb instead.", + "type": "string" + }, + "id": { + "description": "Deprecated - use driveThemes/id instead.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "user": { + "$ref": "User", + "description": "The authenticated user." + } + }, + "type": "object" + }, + "Change": { + "description": "A change to a file or shared drive.", + "id": "Change", + "properties": { + "changeType": { + "description": "The type of the change. Possible values are file and drive.", + "type": "string" + }, + "drive": { + "$ref": "Drive", + "description": "The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted." + }, + "driveId": { + "description": "The ID of the shared drive associated with this change.", + "type": "string" + }, + "file": { + "$ref": "File", + "description": "The updated state of the file. Present if the type is file and the file has not been removed from this list of changes." + }, + "fileId": { + "description": "The ID of the file which has changed.", + "type": "string" + }, + "kind": { + "default": "drive#change", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#change\".", + "type": "string" + }, + "removed": { + "description": "Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.", + "type": "boolean" + }, + "teamDrive": { + "$ref": "TeamDrive", + "description": "Deprecated - use drive instead." + }, + "teamDriveId": { + "description": "Deprecated - use driveId instead.", + "type": "string" + }, + "time": { + "description": "The time of this change (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "type": { + "description": "Deprecated - use changeType instead.", + "type": "string" + } + }, + "type": "object" + }, + "ChangeList": { + "description": "A list of changes for a user.", + "id": "ChangeList", + "properties": { + "changes": { + "description": "The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "Change" + }, + "type": "array" + }, + "kind": { + "default": "drive#changeList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#changeList\".", + "type": "string" + }, + "newStartPageToken": { + "description": "The starting page token for future changes. This will be present only if the end of the current changes list has been reached.", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of changes. This will be absent if the end of the changes 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" + }, + "Channel": { + "description": "An notification channel used to watch for resource changes.", + "id": "Channel", + "properties": { + "address": { + "description": "The address where notifications are delivered for this channel.", + "type": "string" + }, + "expiration": { + "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "A UUID or similar unique string that identifies this channel.", + "type": "string" + }, + "kind": { + "default": "api#channel", + "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", + "type": "string" + }, + "params": { + "additionalProperties": { + "description": "Declares a new parameter by name.", + "type": "string" + }, + "description": "Additional parameters controlling delivery channel behavior. Optional.", + "type": "object" + }, + "payload": { + "description": "A Boolean value to indicate whether payload is wanted. Optional.", + "type": "boolean" + }, + "resourceId": { + "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.", + "type": "string" + }, + "resourceUri": { + "description": "A version-specific identifier for the watched resource.", + "type": "string" + }, + "token": { + "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.", + "type": "string" + }, + "type": { + "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.", + "type": "string" + } + }, + "type": "object" + }, + "Comment": { + "description": "A comment on a file.", + "id": "Comment", + "properties": { + "anchor": { + "description": "A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.", + "type": "string" + }, + "author": { + "$ref": "User", + "description": "The author of the comment. The author's email address and permission ID will not be populated." + }, + "content": { + "annotations": { + "required": [ + "drive.comments.create", + "drive.comments.update" + ] + }, + "description": "The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.", + "type": "string" + }, + "createdTime": { + "description": "The time at which the comment was created (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "deleted": { + "description": "Whether the comment has been deleted. A deleted comment has no content.", + "type": "boolean" + }, + "htmlContent": { + "description": "The content of the comment with HTML formatting.", + "type": "string" + }, + "id": { + "description": "The ID of the comment.", + "type": "string" + }, + "kind": { + "default": "drive#comment", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#comment\".", + "type": "string" + }, + "modifiedTime": { + "description": "The last time the comment or any of its replies was modified (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "quotedFileContent": { + "description": "The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.", + "properties": { + "mimeType": { + "description": "The MIME type of the quoted content.", + "type": "string" + }, + "value": { + "description": "The quoted content itself. This is interpreted as plain text if set through the API.", + "type": "string" + } + }, + "type": "object" + }, + "replies": { + "description": "The full list of replies to the comment in chronological order.", + "items": { + "$ref": "Reply" + }, + "type": "array" + }, + "resolved": { + "description": "Whether the comment has been resolved by one of its replies.", + "type": "boolean" + } + }, + "type": "object" + }, + "CommentList": { + "description": "A list of comments on a file.", + "id": "CommentList", + "properties": { + "comments": { + "description": "The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "Comment" + }, + "type": "array" + }, + "kind": { + "default": "drive#commentList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#commentList\".", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of comments. This will be absent if the end of the comments 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" + }, + "ContentRestriction": { + "description": "A restriction for accessing the content of the file.", + "id": "ContentRestriction", + "properties": { + "readOnly": { + "description": "Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.", + "type": "boolean" + }, + "reason": { + "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.", + "type": "string" + }, + "restrictingUser": { + "$ref": "User", + "description": "The user who set the content restriction. Only populated if readOnly is true." + }, + "restrictionTime": { + "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", + "format": "date-time", + "type": "string" + }, + "type": { + "description": "The type of the content restriction. Currently the only possible value is globalContentRestriction.", + "type": "string" + } + }, + "type": "object" + }, + "Drive": { + "description": "Representation of a shared drive.", + "id": "Drive", + "properties": { + "backgroundImageFile": { + "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", + "properties": { + "id": { + "description": "The ID of an image file in Google Drive to use for the background image.", + "type": "string" + }, + "width": { + "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", + "format": "float", + "type": "number" + }, + "xCoordinate": { + "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", + "format": "float", + "type": "number" + }, + "yCoordinate": { + "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "backgroundImageLink": { + "description": "A short-lived link to this shared drive's background image.", + "type": "string" + }, + "capabilities": { + "description": "Capabilities the current user has on this shared drive.", + "properties": { + "canAddChildren": { + "description": "Whether the current user can add children to folders in this shared drive.", + "type": "boolean" + }, + "canChangeCopyRequiresWriterPermissionRestriction": { + "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.", + "type": "boolean" + }, + "canChangeDomainUsersOnlyRestriction": { + "description": "Whether the current user can change the domainUsersOnly restriction of this shared drive.", + "type": "boolean" + }, + "canChangeDriveBackground": { + "description": "Whether the current user can change the background of this shared drive.", + "type": "boolean" + }, + "canChangeDriveMembersOnlyRestriction": { + "description": "Whether the current user can change the driveMembersOnly restriction of this shared drive.", + "type": "boolean" + }, + "canComment": { + "description": "Whether the current user can comment on files in this shared drive.", + "type": "boolean" + }, + "canCopy": { + "description": "Whether the current user can copy files in this shared drive.", + "type": "boolean" + }, + "canDeleteChildren": { + "description": "Whether the current user can delete children from folders in this shared drive.", + "type": "boolean" + }, + "canDeleteDrive": { + "description": "Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", + "type": "boolean" + }, + "canDownload": { + "description": "Whether the current user can download files in this shared drive.", + "type": "boolean" + }, + "canEdit": { + "description": "Whether the current user can edit files in this shared drive", + "type": "boolean" + }, + "canListChildren": { + "description": "Whether the current user can list the children of folders in this shared drive.", + "type": "boolean" + }, + "canManageMembers": { + "description": "Whether the current user can add members to this shared drive or remove them or change their role.", + "type": "boolean" + }, + "canReadRevisions": { + "description": "Whether the current user can read the revisions resource of files in this shared drive.", + "type": "boolean" + }, + "canRename": { + "description": "Whether the current user can rename files or folders in this shared drive.", + "type": "boolean" + }, + "canRenameDrive": { + "description": "Whether the current user can rename this shared drive.", + "type": "boolean" + }, + "canShare": { + "description": "Whether the current user can share files or folders in this shared drive.", + "type": "boolean" + }, + "canTrashChildren": { + "description": "Whether the current user can trash children from folders in this shared drive.", + "type": "boolean" + } + }, + "type": "object" + }, + "colorRgb": { + "description": "The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.", + "type": "string" + }, + "createdTime": { + "description": "The time at which the shared drive was created (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "hidden": { + "description": "Whether the shared drive is hidden from default view.", + "type": "boolean" + }, + "id": { + "description": "The ID of this shared drive which is also the ID of the top level folder of this shared drive.", + "type": "string" + }, + "kind": { + "default": "drive#drive", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#drive\".", + "type": "string" + }, + "name": { + "description": "The name of this shared drive.", + "type": "string" + }, + "restrictions": { + "description": "A set of restrictions that apply to this shared drive or items inside this shared drive.", + "properties": { + "adminManagedRestrictions": { + "description": "Whether administrative privileges on this shared drive are required to modify restrictions.", + "type": "boolean" + }, + "copyRequiresWriterPermission": { + "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.", + "type": "boolean" + }, + "domainUsersOnly": { + "description": "Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.", + "type": "boolean" + }, + "driveMembersOnly": { + "description": "Whether access to items inside this shared drive is restricted to its members.", + "type": "boolean" + } + }, + "type": "object" + }, + "themeId": { + "description": "The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", + "type": "string" + } + }, + "type": "object" + }, + "DriveList": { + "description": "A list of shared drives.", + "id": "DriveList", + "properties": { + "drives": { + "description": "The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "Drive" + }, + "type": "array" + }, + "kind": { + "default": "drive#driveList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#driveList\".", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of shared drives. This 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" + }, + "File": { + "description": "The metadata for a file.", + "id": "File", + "properties": { + "appProperties": { + "additionalProperties": { + "type": "string" + }, + "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.", + "type": "object" + }, + "capabilities": { + "description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", + "properties": { + "canAddChildren": { + "description": "Whether the current user can add children to this folder. This is always false when the item is not a folder.", + "type": "boolean" + }, + "canAddFolderFromAnotherDrive": { + "description": "Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "type": "boolean" + }, + "canAddMyDriveParent": { + "description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", + "type": "boolean" + }, + "canChangeCopyRequiresWriterPermission": { + "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file.", + "type": "boolean" + }, + "canChangeViewersCanCopyContent": { + "description": "Deprecated", + "type": "boolean" + }, + "canComment": { + "description": "Whether the current user can comment on this file.", + "type": "boolean" + }, + "canCopy": { + "description": "Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.", + "type": "boolean" + }, + "canDelete": { + "description": "Whether the current user can delete this file.", + "type": "boolean" + }, + "canDeleteChildren": { + "description": "Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "type": "boolean" + }, + "canDownload": { + "description": "Whether the current user can download this file.", + "type": "boolean" + }, + "canEdit": { + "description": "Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.", + "type": "boolean" + }, + "canListChildren": { + "description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder.", + "type": "boolean" + }, + "canModifyContent": { + "description": "Whether the current user can modify the content of this file.", + "type": "boolean" + }, + "canModifyContentRestriction": { + "description": "Whether the current user can modify restrictions on content of 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" + }, + "canMoveChildrenOutOfTeamDrive": { + "description": "Deprecated - use canMoveChildrenOutOfDrive instead.", + "type": "boolean" + }, + "canMoveChildrenWithinDrive": { + "description": "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.", + "type": "boolean" + }, + "canMoveChildrenWithinTeamDrive": { + "description": "Deprecated - use canMoveChildrenWithinDrive instead.", + "type": "boolean" + }, + "canMoveItemIntoTeamDrive": { + "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "type": "boolean" + }, + "canMoveItemOutOfDrive": { + "description": "Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.", + "type": "boolean" + }, + "canMoveItemOutOfTeamDrive": { + "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "type": "boolean" + }, + "canMoveItemWithinDrive": { + "description": "Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.", + "type": "boolean" + }, + "canMoveItemWithinTeamDrive": { + "description": "Deprecated - use canMoveItemWithinDrive instead.", + "type": "boolean" + }, + "canMoveTeamDriveItem": { + "description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.", + "type": "boolean" + }, + "canReadDrive": { + "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", + "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" + }, + "canReadTeamDrive": { + "description": "Deprecated - use canReadDrive instead.", + "type": "boolean" + }, + "canRemoveChildren": { + "description": "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.", + "type": "boolean" + }, + "canRemoveMyDriveParent": { + "description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", + "type": "boolean" + }, + "canRename": { + "description": "Whether the current user can rename this file.", + "type": "boolean" + }, + "canShare": { + "description": "Whether the current user can modify the sharing settings for this file.", + "type": "boolean" + }, + "canTrash": { + "description": "Whether the current user can move this file to trash.", + "type": "boolean" + }, + "canTrashChildren": { + "description": "Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "type": "boolean" + }, + "canUntrash": { + "description": "Whether the current user can restore this file from trash.", + "type": "boolean" + } + }, + "type": "object" + }, + "contentHints": { + "description": "Additional information about the content of the file. These fields are never populated in responses.", + "properties": { + "indexableText": { + "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", + "type": "string" + }, + "thumbnail": { + "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", + "properties": { + "image": { + "description": "The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the thumbnail.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "contentRestrictions": { + "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", + "items": { + "$ref": "ContentRestriction" + }, + "type": "array" + }, + "copyRequiresWriterPermission": { + "description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", + "type": "boolean" + }, + "createdTime": { + "description": "The time at which the file was created (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "A short description of the file.", + "type": "string" + }, + "driveId": { + "description": "ID of the shared drive the file resides in. Only populated for items in shared drives.", + "type": "string" + }, + "explicitlyTrashed": { + "description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", + "type": "boolean" + }, + "exportLinks": { + "additionalProperties": { + "description": "A mapping from export format to URL", + "type": "string" + }, + "description": "Links for exporting Docs Editors files to specific formats.", + "type": "object" + }, + "fileExtension": { + "description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive.", + "type": "string" + }, + "folderColorRgb": { + "description": "The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.\nIf an unsupported color is specified, the closest color in the palette will be used instead.", + "type": "string" + }, + "fullFileExtension": { + "description": "The full file extension extracted from the name field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive.\nThis is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.", + "type": "string" + }, + "hasAugmentedPermissions": { + "description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives.", + "type": "boolean" + }, + "hasThumbnail": { + "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", + "type": "boolean" + }, + "headRevisionId": { + "description": "The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.", + "type": "string" + }, + "iconLink": { + "description": "A static, unauthenticated link to the file's icon.", + "type": "string" + }, + "id": { + "description": "The ID of the file.", + "type": "string" + }, + "imageMediaMetadata": { + "description": "Additional metadata about image media, if available.", + "properties": { + "aperture": { + "description": "The aperture used to create the photo (f-number).", + "format": "float", + "type": "number" + }, + "cameraMake": { + "description": "The make of the camera used to create the photo.", + "type": "string" + }, + "cameraModel": { + "description": "The model of the camera used to create the photo.", + "type": "string" + }, + "colorSpace": { + "description": "The color space of the photo.", + "type": "string" + }, + "exposureBias": { + "description": "The exposure bias of the photo (APEX value).", + "format": "float", + "type": "number" + }, + "exposureMode": { + "description": "The exposure mode used to create the photo.", + "type": "string" + }, + "exposureTime": { + "description": "The length of the exposure, in seconds.", + "format": "float", + "type": "number" + }, + "flashUsed": { + "description": "Whether a flash was used to create the photo.", + "type": "boolean" + }, + "focalLength": { + "description": "The focal length used to create the photo, in millimeters.", + "format": "float", + "type": "number" + }, + "height": { + "description": "The height of the image in pixels.", + "format": "int32", + "type": "integer" + }, + "isoSpeed": { + "description": "The ISO speed used to create the photo.", + "format": "int32", + "type": "integer" + }, + "lens": { + "description": "The lens used to create the photo.", + "type": "string" + }, + "location": { + "description": "Geographic location information stored in the image.", + "properties": { + "altitude": { + "description": "The altitude stored in the image.", + "format": "double", + "type": "number" + }, + "latitude": { + "description": "The latitude stored in the image.", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "The longitude stored in the image.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "maxApertureValue": { + "description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value).", + "format": "float", + "type": "number" + }, + "meteringMode": { + "description": "The metering mode used to create the photo.", + "type": "string" + }, + "rotation": { + "description": "The number of clockwise 90 degree rotations applied from the image's original orientation.", + "format": "int32", + "type": "integer" + }, + "sensor": { + "description": "The type of sensor used to create the photo.", + "type": "string" + }, + "subjectDistance": { + "description": "The distance to the subject of the photo, in meters.", + "format": "int32", + "type": "integer" + }, + "time": { + "description": "The date and time the photo was taken (EXIF DateTime).", + "type": "string" + }, + "whiteBalance": { + "description": "The white balance mode used to create the photo.", + "type": "string" + }, + "width": { + "description": "The width of the image in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "isAppAuthorized": { + "description": "Whether the file was created or opened by the requesting app.", + "type": "boolean" + }, + "kind": { + "default": "drive#file", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\".", + "type": "string" + }, + "lastModifyingUser": { + "$ref": "User", + "description": "The last user to modify the file." + }, + "md5Checksum": { + "description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the file.\nGoogle Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.\nIf a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.", + "type": "string" + }, + "modifiedByMe": { + "description": "Whether the file has been modified by this user.", + "type": "boolean" + }, + "modifiedByMeTime": { + "description": "The last time the file was modified by the user (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "modifiedTime": { + "description": "The last time the file was modified by anyone (RFC 3339 date-time).\nNote that setting modifiedTime will also update modifiedByMeTime for the user.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", + "type": "string" + }, + "originalFilename": { + "description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.", + "type": "string" + }, + "ownedByMe": { + "description": "Whether the user owns the file. Not populated for items in shared drives.", + "type": "boolean" + }, + "owners": { + "description": "The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.", + "items": { + "$ref": "User" + }, + "type": "array" + }, + "parents": { + "description": "The IDs of the parent folders which contain the file.\nIf not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.", + "items": { + "type": "string" + }, + "type": "array" + }, + "permissionIds": { + "description": "List of permission IDs for users with access to this file.", + "items": { + "type": "string" + }, + "type": "array" + }, + "permissions": { + "description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.", + "items": { + "$ref": "Permission" + }, + "type": "array" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.", + "type": "object" + }, + "quotaBytesUsed": { + "description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.", + "format": "int64", + "type": "string" + }, + "shared": { + "description": "Whether the file has been shared. Not populated for items in shared drives.", + "type": "boolean" + }, + "sharedWithMeTime": { + "description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "sharingUser": { + "$ref": "User", + "description": "The user who shared the file with the requesting user, if applicable." + }, + "shortcutDetails": { + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.", + "properties": { + "targetId": { + "description": "The ID of the file that this shortcut points to.", + "type": "string" + }, + "targetMimeType": { + "description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", + "type": "string" + } + }, + "type": "object" + }, + "size": { + "description": "The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.", + "format": "int64", + "type": "string" + }, + "spaces": { + "description": "The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", + "items": { + "type": "string" + }, + "type": "array" + }, + "starred": { + "description": "Whether the user has starred the file.", + "type": "boolean" + }, + "teamDriveId": { + "description": "Deprecated - use driveId instead.", + "type": "string" + }, + "thumbnailLink": { + "description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.", + "type": "string" + }, + "thumbnailVersion": { + "description": "The thumbnail version for use in thumbnail cache invalidation.", + "format": "int64", + "type": "string" + }, + "trashed": { + "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. 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.", + "type": "boolean" + }, + "trashedTime": { + "description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.", + "format": "date-time", + "type": "string" + }, + "trashingUser": { + "$ref": "User", + "description": "If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." + }, + "version": { + "description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.", + "format": "int64", + "type": "string" + }, + "videoMediaMetadata": { + "description": "Additional metadata about video media. This may not be available immediately upon upload.", + "properties": { + "durationMillis": { + "description": "The duration of the video in milliseconds.", + "format": "int64", + "type": "string" + }, + "height": { + "description": "The height of the video in pixels.", + "format": "int32", + "type": "integer" + }, + "width": { + "description": "The width of the video in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "viewedByMe": { + "description": "Whether the file has been viewed by this user.", + "type": "boolean" + }, + "viewedByMeTime": { + "description": "The last time the file was viewed by the user (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "viewersCanCopyContent": { + "description": "Deprecated - use copyRequiresWriterPermission instead.", + "type": "boolean" + }, + "webContentLink": { + "description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", + "type": "string" + }, + "webViewLink": { + "description": "A link for opening the file in a relevant Google editor or viewer in a browser.", + "type": "string" + }, + "writersCanShare": { + "description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.", + "type": "boolean" + } + }, + "type": "object" + }, + "FileList": { + "description": "A list of files.", + "id": "FileList", + "properties": { + "files": { + "description": "The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "File" + }, + "type": "array" + }, + "incompleteSearch": { + "description": "Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the \"allDrives\" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as \"user\" or \"drive\".", + "type": "boolean" + }, + "kind": { + "default": "drive#fileList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#fileList\".", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of files. This will be absent if the end of the files 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" + }, + "GeneratedIds": { + "description": "A list of generated file IDs which can be provided in create requests.", + "id": "GeneratedIds", + "properties": { + "ids": { + "description": "The IDs generated for the requesting user in the specified space.", + "items": { + "type": "string" + }, + "type": "array" + }, + "kind": { + "default": "drive#generatedIds", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#generatedIds\".", + "type": "string" + }, + "space": { + "description": "The type of file that can be created with these IDs.", + "type": "string" + } + }, + "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", + "properties": { + "allowFileDiscovery": { + "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.", + "type": "boolean" + }, + "deleted": { + "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", + "type": "boolean" + }, + "displayName": { + "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"thecompany.com.\" \n- anyone - No displayName is present.", + "type": "string" + }, + "domain": { + "description": "The domain to which this permission refers.", + "type": "string" + }, + "emailAddress": { + "description": "The email address of the user or group to which this permission refers.", + "type": "string" + }, + "expirationTime": { + "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They can only be set on user and group permissions \n- The time must be in the future \n- The time cannot be more than a year in the future", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", + "type": "string" + }, + "kind": { + "default": "drive#permission", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", + "type": "string" + }, + "permissionDetails": { + "description": "Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", + "items": { + "properties": { + "inherited": { + "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", + "type": "boolean" + }, + "inheritedFrom": { + "description": "The ID of the item from which this permission is inherited. This is an output-only field.", + "type": "string" + }, + "permissionType": { + "description": "The permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member", + "type": "string" + }, + "role": { + "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "photoLink": { + "description": "A link to the user's profile photo, if available.", + "type": "string" + }, + "role": { + "annotations": { + "required": [ + "drive.permissions.create" + ] + }, + "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", + "type": "string" + }, + "teamDrivePermissionDetails": { + "description": "Deprecated - use permissionDetails instead.", + "items": { + "properties": { + "inherited": { + "description": "Deprecated - use permissionDetails/inherited instead.", + "type": "boolean" + }, + "inheritedFrom": { + "description": "Deprecated - use permissionDetails/inheritedFrom instead.", + "type": "string" + }, + "role": { + "description": "Deprecated - use permissionDetails/role instead.", + "type": "string" + }, + "teamDrivePermissionType": { + "description": "Deprecated - use permissionDetails/permissionType instead.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "annotations": { + "required": [ + "drive.permissions.create" + ] + }, + "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.", + "type": "string" + }, + "view": { + "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", + "type": "string" + } + }, + "type": "object" + }, + "PermissionList": { + "description": "A list of permissions for a file.", + "id": "PermissionList", + "properties": { + "kind": { + "default": "drive#permissionList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permissionList\".", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of permissions. This field will be absent if the end of the permissions 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" + }, + "permissions": { + "description": "The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "Permission" + }, + "type": "array" + } + }, + "type": "object" + }, + "Reply": { + "description": "A reply to a comment on a file.", + "id": "Reply", + "properties": { + "action": { + "description": "The action the reply performed to the parent comment. Valid values are: \n- resolve \n- reopen", + "type": "string" + }, + "author": { + "$ref": "User", + "description": "The author of the reply. The author's email address and permission ID will not be populated." + }, + "content": { + "annotations": { + "required": [ + "drive.replies.update" + ] + }, + "description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.", + "type": "string" + }, + "createdTime": { + "description": "The time at which the reply was created (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "deleted": { + "description": "Whether the reply has been deleted. A deleted reply has no content.", + "type": "boolean" + }, + "htmlContent": { + "description": "The content of the reply with HTML formatting.", + "type": "string" + }, + "id": { + "description": "The ID of the reply.", + "type": "string" + }, + "kind": { + "default": "drive#reply", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\".", + "type": "string" + }, + "modifiedTime": { + "description": "The last time the reply was modified (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "ReplyList": { + "description": "A list of replies to a comment on a file.", + "id": "ReplyList", + "properties": { + "kind": { + "default": "drive#replyList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#replyList\".", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of replies. This will be absent if the end of the replies 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" + }, + "replies": { + "description": "The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "Reply" + }, + "type": "array" + } + }, + "type": "object" + }, + "Revision": { + "description": "The metadata for a revision to a file.", + "id": "Revision", + "properties": { + "exportLinks": { + "additionalProperties": { + "description": "A mapping from export format to URL", + "type": "string" + }, + "description": "Links for exporting Docs Editors files to specific formats.", + "type": "object" + }, + "id": { + "description": "The ID of the revision.", + "type": "string" + }, + "keepForever": { + "description": "Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.\nThis field is only applicable to files with binary content in Drive.", + "type": "boolean" + }, + "kind": { + "default": "drive#revision", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#revision\".", + "type": "string" + }, + "lastModifyingUser": { + "$ref": "User", + "description": "The last user to modify this revision." + }, + "md5Checksum": { + "description": "The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the revision.", + "type": "string" + }, + "modifiedTime": { + "description": "The last time the revision was modified (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "originalFilename": { + "description": "The original filename used to create this revision. This is only applicable to files with binary content in Drive.", + "type": "string" + }, + "publishAuto": { + "description": "Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.", + "type": "boolean" + }, + "published": { + "description": "Whether this revision is published. This is only applicable to Docs Editors files.", + "type": "boolean" + }, + "publishedLink": { + "description": "A link to the published revision. This is only populated for Google Sites files.", + "type": "string" + }, + "publishedOutsideDomain": { + "description": "Whether this revision is published outside the domain. This is only applicable to Docs Editors files.", + "type": "boolean" + }, + "size": { + "description": "The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RevisionList": { + "description": "A list of revisions of a file.", + "id": "RevisionList", + "properties": { + "kind": { + "default": "drive#revisionList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#revisionList\".", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of revisions. This will be absent if the end of the revisions 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" + }, + "revisions": { + "description": "The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "Revision" + }, + "type": "array" + } + }, + "type": "object" + }, + "StartPageToken": { + "id": "StartPageToken", + "properties": { + "kind": { + "default": "drive#startPageToken", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#startPageToken\".", + "type": "string" + }, + "startPageToken": { + "description": "The starting page token for listing changes.", + "type": "string" + } + }, + "type": "object" + }, + "TeamDrive": { + "description": "Deprecated: use the drive collection instead.", + "id": "TeamDrive", + "properties": { + "backgroundImageFile": { + "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", + "properties": { + "id": { + "description": "The ID of an image file in Drive to use for the background image.", + "type": "string" + }, + "width": { + "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", + "format": "float", + "type": "number" + }, + "xCoordinate": { + "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", + "format": "float", + "type": "number" + }, + "yCoordinate": { + "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "backgroundImageLink": { + "description": "A short-lived link to this Team Drive's background image.", + "type": "string" + }, + "capabilities": { + "description": "Capabilities the current user has on this Team Drive.", + "properties": { + "canAddChildren": { + "description": "Whether the current user can add children to folders in this Team Drive.", + "type": "boolean" + }, + "canChangeCopyRequiresWriterPermissionRestriction": { + "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.", + "type": "boolean" + }, + "canChangeDomainUsersOnlyRestriction": { + "description": "Whether the current user can change the domainUsersOnly restriction of this Team Drive.", + "type": "boolean" + }, + "canChangeTeamDriveBackground": { + "description": "Whether the current user can change the background of this Team Drive.", + "type": "boolean" + }, + "canChangeTeamMembersOnlyRestriction": { + "description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive.", + "type": "boolean" + }, + "canComment": { + "description": "Whether the current user can comment on files in this Team Drive.", + "type": "boolean" + }, + "canCopy": { + "description": "Whether the current user can copy files in this Team Drive.", + "type": "boolean" + }, + "canDeleteChildren": { + "description": "Whether the current user can delete children from folders in this Team Drive.", + "type": "boolean" + }, + "canDeleteTeamDrive": { + "description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.", + "type": "boolean" + }, + "canDownload": { + "description": "Whether the current user can download files in this Team Drive.", + "type": "boolean" + }, + "canEdit": { + "description": "Whether the current user can edit files in this Team Drive", + "type": "boolean" + }, + "canListChildren": { + "description": "Whether the current user can list the children of folders in this Team Drive.", + "type": "boolean" + }, + "canManageMembers": { + "description": "Whether the current user can add members to this Team Drive or remove them or change their role.", + "type": "boolean" + }, + "canReadRevisions": { + "description": "Whether the current user can read the revisions resource of files in this Team Drive.", + "type": "boolean" + }, + "canRemoveChildren": { + "description": "Deprecated - use canDeleteChildren or canTrashChildren instead.", + "type": "boolean" + }, + "canRename": { + "description": "Whether the current user can rename files or folders in this Team Drive.", + "type": "boolean" + }, + "canRenameTeamDrive": { + "description": "Whether the current user can rename this Team Drive.", + "type": "boolean" + }, + "canShare": { + "description": "Whether the current user can share files or folders in this Team Drive.", + "type": "boolean" + }, + "canTrashChildren": { + "description": "Whether the current user can trash children from folders in this Team Drive.", + "type": "boolean" + } + }, + "type": "object" + }, + "colorRgb": { + "description": "The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.", + "type": "string" + }, + "createdTime": { + "description": "The time at which the Team Drive was created (RFC 3339 date-time).", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.", + "type": "string" + }, + "kind": { + "default": "drive#teamDrive", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDrive\".", + "type": "string" + }, + "name": { + "description": "The name of this Team Drive.", + "type": "string" + }, + "restrictions": { + "description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.", + "properties": { + "adminManagedRestrictions": { + "description": "Whether administrative privileges on this Team Drive are required to modify restrictions.", + "type": "boolean" + }, + "copyRequiresWriterPermission": { + "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive.", + "type": "boolean" + }, + "domainUsersOnly": { + "description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.", + "type": "boolean" + }, + "teamMembersOnly": { + "description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive.", + "type": "boolean" + } + }, + "type": "object" + }, + "themeId": { + "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", + "type": "string" + } + }, + "type": "object" + }, + "TeamDriveList": { + "description": "A list of Team Drives.", + "id": "TeamDriveList", + "properties": { + "kind": { + "default": "drive#teamDriveList", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDriveList\".", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of Team Drives. This will be absent if the end of the Team Drives 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" + }, + "teamDrives": { + "description": "The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "TeamDrive" + }, + "type": "array" + } + }, + "type": "object" + }, + "User": { + "description": "Information about a Drive user.", + "id": "User", + "properties": { + "displayName": { + "description": "A plain text displayable name for this user.", + "type": "string" + }, + "emailAddress": { + "description": "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.", + "type": "string" + }, + "kind": { + "default": "drive#user", + "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", + "type": "string" + }, + "me": { + "description": "Whether this user is the requesting user.", + "type": "boolean" + }, + "permissionId": { + "description": "The user's ID as visible in Permission resources.", + "type": "string" + }, + "photoLink": { + "description": "A link to the user's profile photo, if available.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "drive/v3/", + "title": "Drive API", + "version": "v3" +} \ No newline at end of file diff --git a/scripts/updatediscoveryartifacts.py b/scripts/updatediscoveryartifacts.py new file mode 100644 index 00000000000..1821ba8c7b3 --- /dev/null +++ b/scripts/updatediscoveryartifacts.py @@ -0,0 +1,72 @@ +# Copyright 2021 Google LLC + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# https://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +import pathlib +import shutil +import subprocess +import tempfile + +import describe +import changesummary + + +SCRIPTS_DIR = pathlib.Path(__file__).parent.resolve() +DISCOVERY_DOC_DIR = SCRIPTS_DIR / ".." / "googleapiclient" / "discovery_cache" / "documents" +REFERENCE_DOC_DIR = SCRIPTS_DIR / ".." / "docs" / "dyn" +TEMP_DIR = SCRIPTS_DIR / "temp" + +# Clear discovery documents and reference documents directory +shutil.rmtree(DISCOVERY_DOC_DIR, ignore_errors=True) +shutil.rmtree(REFERENCE_DOC_DIR, ignore_errors=True) + +# Clear temporary directory +shutil.rmtree(TEMP_DIR, ignore_errors=True) + +# Check out a fresh copy +subprocess.call(['git', 'checkout', DISCOVERY_DOC_DIR]) +subprocess.call(['git', 'checkout', REFERENCE_DOC_DIR]) + +# Snapshot current discovery artifacts to a temporary directory +with tempfile.TemporaryDirectory() as current_discovery_doc_dir: + shutil.copytree(DISCOVERY_DOC_DIR, current_discovery_doc_dir, dirs_exist_ok=True) + + # Download discovery artifacts and generate documentation + describe.generate_all_api_documents() + + # Get a list of files changed using `git diff` + git_diff_output = subprocess.check_output(['git', + 'diff', + 'origin/master', + '--name-only', + '--', + DISCOVERY_DOC_DIR / '*.json', + REFERENCE_DOC_DIR / '*.html', + REFERENCE_DOC_DIR / '*.md', + ], + universal_newlines=True) + + # Create lists of the changed files + all_changed_files = [pathlib.Path(file_name).name for file_name in git_diff_output.split('\n')] + json_changed_files = [file for file in all_changed_files if file.endswith(".json")] + + # Create temporary directory + pathlib.Path(TEMP_DIR).mkdir() + + # Analyze the changes in discovery artifacts using the changesummary module + changesummary.ChangeSummary(DISCOVERY_DOC_DIR, current_discovery_doc_dir, TEMP_DIR, json_changed_files).detect_discovery_changes() + + # Write a list of the files changed to a file called `changed files` which will be used in the `createcommits.sh` script. + with open(TEMP_DIR / "changed_files", "w") as f: + f.writelines('\n'.join(all_changed_files)) diff --git a/setup.py b/setup.py index 0d51ab3e761..caba2c5f666 100644 --- a/setup.py +++ b/setup.py @@ -46,7 +46,7 @@ with io.open(readme_filename, encoding="utf-8") as readme_file: readme = readme_file.read() -version = "2.2.0" +version = "2.3.0" setup( name="google-api-python-client", diff --git a/synth.metadata b/synth.metadata index e428d5ed98e..822bbc9236b 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,14 +4,14 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-python-client.git", - "sha": "bd2c5f9c5c5181e21cf970eb6f966afcf0323723" + "sha": "c4ecb6ce55deb57469e380d95d7a3db2e9160fa0" } }, { "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "0a071b3460344886297a304253bf924aa68ddb7e" + "sha": "043cc620d6a6111816d9e09f2a97208565fde958" } } ], diff --git a/tests/test_discovery.py b/tests/test_discovery.py index 43ab2c79a8d..26820555007 100644 --- a/tests/test_discovery.py +++ b/tests/test_discovery.py @@ -632,7 +632,9 @@ def test_api_endpoint_override_from_client_options_mapping_object(self): api_endpoint = "https://foo.googleapis.com/" mapping_object = defaultdict(str) mapping_object["api_endpoint"] = api_endpoint - plus = build_from_document(discovery, client_options=mapping_object) + plus = build_from_document( + discovery, client_options=mapping_object, credentials=self.MOCK_CREDENTIALS + ) self.assertEqual(plus._baseUrl, api_endpoint)