diff --git a/.github/auto-approve.yml b/.github/auto-approve.yml index c163c081165..7e10d45ccab 100644 --- a/.github/auto-approve.yml +++ b/.github/auto-approve.yml @@ -1,20 +1,5 @@ # https://github.com/googleapis/repo-automation-bots/tree/main/packages/auto-approve -rules: - -# incoming PRs from yoshi-code-bot -- author: "yoshi-code-bot" - -# Title for PRs from yoshi-code-bot MUST start with `chore: Update discovery artifacts`. -# Title must be regex. - title: "^chore: Update discovery artifacts" - -# The only changed file paths in an incoming PR MUST be exactly -# `"^docs/dyn/index.md$"` or follow either one of these patterns `"docs/dyn/*.html"` -# or `"googleapiclient/discovery_cache/documents/*.json"` . These are -# listed in regex. If this property is omitted, auto-approve bot will allow PRs -# that match the author and title to merge, without checking the file paths. - changedFiles: - - "^docs/dyn/index.md$" - - "^docs/dyn/.*\\.html$" - - "^googleapiclient/discovery_cache/documents/.*\\.json$" +processes: + - "UpdateDiscoveryArtifacts" + - "OwlBotTemplateChanges" diff --git a/.repo-metadata.json b/.repo-metadata.json index 439e06616db..5e070bda1f2 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -3,7 +3,7 @@ "name_pretty": "Google API Python Client", "client_documentation": "https://github.com/googleapis/google-api-python-client/tree/main/docs#google-api-client-library-for-python-docs", "issue_tracker": "https://github.com/googleapis/google-api-python-client/issues", - "release_level": "ga", + "release_level": "stable", "language": "python", "library_type": "REST", "repo": "googleapis/google-api-python-client", diff --git a/CHANGELOG.md b/CHANGELOG.md index 8fe80ab29e8..34469bd30f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,35 @@ # Changelog +## [2.34.0](https://www.github.com/googleapis/google-api-python-client/compare/v2.33.0...v2.34.0) (2022-01-05) + + +### Features + +* **alertcenter:** update the api https://github.com/googleapis/google-api-python-client/commit/945a281fc6a055f37d68a742959bdd18aaf6eb62 ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **analyticsdata:** update the api https://github.com/googleapis/google-api-python-client/commit/90327d9a1b198523773d730402c5274c424ddf8f ([797d677](https://www.github.com/googleapis/google-api-python-client/commit/797d67740e7a8493c7e5fccdce3b88b0de90883b)) +* **apigee:** update the api https://github.com/googleapis/google-api-python-client/commit/a2271c7c184e8d75b6370cf139ca464e4ebe435d ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **clouddeploy:** update the api https://github.com/googleapis/google-api-python-client/commit/e98fcec145aeb43c1a962404c4599b63dbe7443c ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **cloudsearch:** update the api https://github.com/googleapis/google-api-python-client/commit/6a63e51e98ea3d3662b0dd89e95636ddf14ef941 ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **compute:** update the api https://github.com/googleapis/google-api-python-client/commit/4f21ebf8fd2a9fd1e838e74266e8f8ed847c5236 ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **contactcenterinsights:** update the api https://github.com/googleapis/google-api-python-client/commit/bb409be9296aef9c3e106476999e6e1c37d2fa8a ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **container:** update the api https://github.com/googleapis/google-api-python-client/commit/5687b00d4ba57a2ddb4311f66ae627f1c4f3807d ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **dialogflow:** update the api https://github.com/googleapis/google-api-python-client/commit/d026eb98f0eee8889aa7b55d507296074a140da5 ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **dns:** update the api https://github.com/googleapis/google-api-python-client/commit/f96d280615ea04400a22fe9b7fae31bb6e10e4fe ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* expose library version at googleapiclient.__version__ ([#1623](https://www.github.com/googleapis/google-api-python-client/issues/1623)) ([83db1d7](https://www.github.com/googleapis/google-api-python-client/commit/83db1d71395e92fb2bd814a31713bd8ba3f412ca)) +* **healthcare:** update the api https://github.com/googleapis/google-api-python-client/commit/8a11e53e91c04caba64091272b8e8e7a5b482c41 ([797d677](https://www.github.com/googleapis/google-api-python-client/commit/797d67740e7a8493c7e5fccdce3b88b0de90883b)) +* **networkconnectivity:** update the api https://github.com/googleapis/google-api-python-client/commit/6de66e85f4cddf5a26c37c35db2ca0ef561c41fb ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **recaptchaenterprise:** update the api https://github.com/googleapis/google-api-python-client/commit/953a206f931396b030aa521323d05a4467b47d05 ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **securitycenter:** update the api https://github.com/googleapis/google-api-python-client/commit/db02cdb70461284f33d1cce098a1babb191a1e87 ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **serviceconsumermanagement:** update the api https://github.com/googleapis/google-api-python-client/commit/a8a823f893b0208b9b8e1a71518726c1a919db5b ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **servicenetworking:** update the api https://github.com/googleapis/google-api-python-client/commit/b9be56f5967f7112a3b4620e89fffac4c82907ae ([797d677](https://www.github.com/googleapis/google-api-python-client/commit/797d67740e7a8493c7e5fccdce3b88b0de90883b)) +* **serviceusage:** update the api https://github.com/googleapis/google-api-python-client/commit/743505720e00bf57f0f2347b0c9c4b1cbed1ecc9 ([5a6231d](https://www.github.com/googleapis/google-api-python-client/commit/5a6231d31156644fdc0fd5a6ef8a0cef25d1dd9b)) +* **testing:** update the api https://github.com/googleapis/google-api-python-client/commit/98d5c1de2a32dce65697bffeb87b3a520ae5a94e ([797d677](https://www.github.com/googleapis/google-api-python-client/commit/797d67740e7a8493c7e5fccdce3b88b0de90883b)) + + +### Bug Fixes + +* **deps:** require uritemplate 3.0.1 ([#1629](https://www.github.com/googleapis/google-api-python-client/issues/1629)) ([1c4cfdb](https://www.github.com/googleapis/google-api-python-client/commit/1c4cfdb76560f757cec9dbc56a290ee748a07ef0)) + ## [2.33.0](https://www.github.com/googleapis/google-api-python-client/compare/v2.32.0...v2.33.0) (2021-12-07) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8af7af6b426..9c1114009e9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,61 +1,281 @@ -How to Contribute -================= +.. Generated by synthtool. DO NOT EDIT! +############ +Contributing +############ -We'd love to accept your patches and contributions to this project. -There are a few guidelines described in our -`Contribution Guide `__ -that you need to follow. +#. **Please sign one of the contributor license agreements below.** +#. Fork the repo, develop and test your code changes, add docs. +#. Make sure that your commit messages clearly describe the changes. +#. Send a pull request. (Please Read: `Faster Pull Request Reviews`_) -To summarize here: when contributing, please: +.. _Faster Pull Request Reviews: https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews -* Sign Contributor License Agreement -* Before making changes, file an issue -* Fork this repository and use github pull requests for all submissions -* Follow - `Contributor Code of Conduct - `__ - and `Community Guidelines `__ -* Follow `Google Python Style Guide `__ - and `this commit authoring style `__ -* Don't forget to write tests and update documentation! +.. contents:: Here are some guidelines for hacking on the Google Cloud Client libraries. -Setup Notes ------------ +*************** +Adding Features +*************** -Please follow these steps after forking and cloning the repository -to make sure you can modify code and run tests with confidence:: +In order to add a feature: - # From the root dir of the cloned repository: - # Create Virtual Environment called env (you may choose your own name) - python3 -m venv env +- The feature must be documented in both the API and narrative + documentation. - # Activate virtual environment - source env/bin/activate +- The feature must work fully on the following CPython versions: + 3.6, 3.7, 3.8, 3.9 and 3.10 on both UNIX and Windows. - # Install this library as editable install - # (see https://pip.pypa.io/en/stable/reference/pip_install/#cmdoption-e) - python3 -m pip install -e . +- The feature must not add unnecessary dependencies (where + "unnecessary" is of course subjective, but new dependencies should + be discussed). - # Install nox - python3 -m pip install nox +**************************** +Using a Development Checkout +**************************** -We use `nox `__ to instrument our tests. -To test your changes, run unit tests with ``nox``:: +You'll have to create a development environment using a Git checkout: - # Run tests for all supported versions of Python and oauth2client: - nox - # Run tests for Python 3.7: - nox -s unit-3.7 - # Run lint - nox -s lint +- While logged into your GitHub account, navigate to the + ``google-api-python-client`` `repo`_ on GitHub. +- Fork and clone the ``google-api-python-client`` repository to your GitHub account by + clicking the "Fork" button. -.. note:: +- Clone your fork of ``google-api-python-client`` from your GitHub account to your local + computer, substituting your account username and specifying the destination + as ``hack-on-google-api-python-client``. E.g.:: - The unit tests and system tests are described in the - ``noxfile.py`` file in this directory. Nox will automatically - handle constriction of new virtual environments and installation - of the required test dependencies. + $ cd ${HOME} + $ git clone git@github.com:USERNAME/google-api-python-client.git hack-on-google-api-python-client + $ cd hack-on-google-api-python-client + # Configure remotes such that you can pull changes from the googleapis/google-api-python-client + # repository into your local repository. + $ git remote add upstream git@github.com:googleapis/google-api-python-client.git + # fetch and merge changes from upstream into main + $ git fetch upstream + $ git merge upstream/main -For more information about Nox, including command-line usage, consult -`nox documentation `__. +Now your local repo is set up such that you will push changes to your GitHub +repo, from which you can submit a pull request. + +To work on the codebase and run the tests, we recommend using ``nox``, +but you can also use a ``virtualenv`` of your own creation. + +.. _repo: https://github.com/googleapis/google-api-python-client + +Using ``nox`` +============= + +We use `nox `__ to instrument our tests. + +- To test your changes, run unit tests with ``nox``:: + $ nox -s unit + +- To run a single unit test:: + + $ nox -s unit-3.10 -- -k + + + .. note:: + + The unit tests and system tests are described in the + ``noxfile.py`` files in each directory. + +.. nox: https://pypi.org/project/nox/ + +***************************************** +I'm getting weird errors... Can you help? +***************************************** + +If the error mentions ``Python.h`` not being found, +install ``python-dev`` and try again. +On Debian/Ubuntu:: + + $ sudo apt-get install python-dev + +************ +Coding Style +************ +- We use the automatic code formatter ``black``. You can run it using + the nox session ``blacken``. This will eliminate many lint errors. Run via:: + + $ nox -s blacken + +- PEP8 compliance is required, with exceptions defined in the linter configuration. + If you have ``nox`` installed, you can test that you have not introduced + any non-compliant code via:: + + $ nox -s lint + +- In order to make ``nox -s lint`` run faster, you can set some environment + variables:: + + export GOOGLE_CLOUD_TESTING_REMOTE="upstream" + export GOOGLE_CLOUD_TESTING_BRANCH="main" + + By doing this, you are specifying the location of the most up-to-date + version of ``google-api-python-client``. The + remote name ``upstream`` should point to the official ``googleapis`` + checkout and the branch should be the default branch on that remote (``main``). + +- This repository contains configuration for the + `pre-commit `__ tool, which automates checking + our linters during a commit. If you have it installed on your ``$PATH``, + you can enable enforcing those checks via: + +.. code-block:: bash + + $ pre-commit install + pre-commit installed at .git/hooks/pre-commit + +Exceptions to PEP8: + +- Many unit tests use a helper method, ``_call_fut`` ("FUT" is short for + "Function-Under-Test"), which is PEP8-incompliant, but more readable. + Some also use a local variable, ``MUT`` (short for "Module-Under-Test"). + +******************** +Running System Tests +******************** + +- To run system tests, you can execute:: + + # Run all system tests + $ nox -s system + + # Run a single system test + $ nox -s system-3.8 -- -k + + + .. note:: + + System tests are only configured to run under Python 3.8. + For expediency, we do not run them in older versions of Python 3. + + This alone will not run the tests. You'll need to change some local + auth settings and change some configuration in your project to + run all the tests. + +- System tests will be run against an actual project. You should use local credentials from gcloud when possible. See `Best practices for application authentication `__. Some tests require a service account. For those tests see `Authenticating as a service account `__. + +************* +Test Coverage +************* + +- The codebase *must* have 100% test statement coverage after each commit. + You can test coverage via ``nox -s cover``. + +****************************************************** +Documentation Coverage and Building HTML Documentation +****************************************************** + +If you fix a bug, and the bug requires an API or behavior modification, all +documentation in this package which references that API or behavior must be +changed to reflect the bug fix, ideally in the same commit that fixes the bug +or adds the feature. + +Build the docs via: + + $ nox -s docs + +************************* +Samples and code snippets +************************* + +Code samples and snippets live in the `samples/` catalogue. Feel free to +provide more examples, but make sure to write tests for those examples. +Each folder containing example code requires its own `noxfile.py` script +which automates testing. If you decide to create a new folder, you can +base it on the `samples/snippets` folder (providing `noxfile.py` and +the requirements files). + +The tests will run against a real Google Cloud Project, so you should +configure them just like the System Tests. + +- To run sample tests, you can execute:: + + # Run all tests in a folder + $ cd samples/snippets + $ nox -s py-3.8 + + # Run a single sample test + $ cd samples/snippets + $ nox -s py-3.8 -- -k + +******************************************** +Note About ``README`` as it pertains to PyPI +******************************************** + +The `description on PyPI`_ for the project comes directly from the +``README``. Due to the reStructuredText (``rst``) parser used by +PyPI, relative links which will work on GitHub (e.g. ``CONTRIBUTING.rst`` +instead of +``https://github.com/googleapis/google-api-python-client/blob/main/CONTRIBUTING.rst``) +may cause problems creating links or rendering the description. + +.. _description on PyPI: https://pypi.org/project/google-api-python-client + + +************************* +Supported Python Versions +************************* + +We support: + +- `Python 3.6`_ +- `Python 3.7`_ +- `Python 3.8`_ +- `Python 3.9`_ +- `Python 3.10`_ + +.. _Python 3.6: https://docs.python.org/3.6/ +.. _Python 3.7: https://docs.python.org/3.7/ +.. _Python 3.8: https://docs.python.org/3.8/ +.. _Python 3.9: https://docs.python.org/3.9/ +.. _Python 3.10: https://docs.python.org/3.10/ + + +Supported versions can be found in our ``noxfile.py`` `config`_. + +.. _config: https://github.com/googleapis/google-api-python-client/blob/main/noxfile.py + + +We also explicitly decided to support Python 3 beginning with version 3.6. +Reasons for this include: + +- Encouraging use of newest versions of Python 3 +- Taking the lead of `prominent`_ open-source `projects`_ +- `Unicode literal support`_ which allows for a cleaner codebase that + works in both Python 2 and Python 3 + +.. _prominent: https://docs.djangoproject.com/en/1.9/faq/install/#what-python-version-can-i-use-with-django +.. _projects: http://flask.pocoo.org/docs/0.10/python3/ +.. _Unicode literal support: https://www.python.org/dev/peps/pep-0414/ + +********** +Versioning +********** + +This library follows `Semantic Versioning`_. + +.. _Semantic Versioning: http://semver.org/ + +Some packages are currently in major version zero (``0.y.z``), which means that +anything may change at any time and the public API should not be considered +stable. + +****************************** +Contributor License Agreements +****************************** + +Before we can accept your pull requests you'll need to sign a Contributor +License Agreement (CLA): + +- **If you are an individual writing original source code** and **you own the + intellectual property**, then you'll need to sign an + `individual CLA `__. +- **If you work for a company that wants to allow you to contribute your work**, + then you'll need to sign a + `corporate CLA `__. + +You can sign these electronically (just scroll to the bottom). After that, +we'll be able to accept your pull requests. diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html index 46771be5bdb..610fa87e80c 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html @@ -79,25 +79,28 @@

Instance Methods

Close httplib2 connections.

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

-

Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

+

Creates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.

delete(name, x__xgafv=None)

-

Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.

+

Deletes an access level based on the resource name. The long-running operation from this RPC has a successful status after the access level has been removed from long-lasting storage.

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

-

Get an Access Level by resource name.

+

Gets an access level based on the resource name.

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

-

List all Access Levels for an access policy.

+

Lists all access levels for an access policy.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

+

Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.

replaceAll(parent, body=None, x__xgafv=None)

-

Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.

+

Replaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing access levels are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing access levels contained in existing service perimeters result in an error.

+

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

+

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Method Details

close() @@ -106,7 +109,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
+  
Creates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.
 
 Args:
   parent: string, Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}` (required)
@@ -196,7 +199,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.
+  
Deletes an access level based on the resource name. The long-running operation from this RPC has a successful status after the access level has been removed from long-lasting storage.
 
 Args:
   name: string, Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required)
@@ -231,7 +234,7 @@ 

Method Details

get(name, accessLevelFormat=None, x__xgafv=None) -
Get an Access Level by resource name.
+  
Gets an access level based on the resource name.
 
 Args:
   name: string, Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required)
@@ -303,7 +306,7 @@ 

Method Details

list(parent, accessLevelFormat=None, pageSize=None, pageToken=None, x__xgafv=None) -
List all Access Levels for an access policy.
+  
Lists all access levels for an access policy.
 
 Args:
   parent: string, Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}` (required)
@@ -396,7 +399,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
+  
Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.
 
 Args:
   name: string, Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters. (required)
@@ -487,7 +490,7 @@ 

Method Details

replaceAll(parent, body=None, x__xgafv=None) -
Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.
+  
Replaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing access levels are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing access levels contained in existing service perimeters result in an error.
 
 Args:
   parent: string, Required. Resource name for the access policy which owns these Access Levels. Format: `accessPolicies/{policy_id}` (required)
@@ -580,4 +583,34 @@ 

Method Details

}
+
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # 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).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.html index 30ca5772926..c053f507dc7 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.html @@ -89,22 +89,31 @@

Instance Methods

Close httplib2 connections.

create(body=None, x__xgafv=None)

-

Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.

+

Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto.

delete(name, x__xgafv=None)

-

Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.

+

Deletes an access policy based on the resource name. The long-running operation has a successful status after the access policy is removed from long-lasting storage.

get(name, x__xgafv=None)

-

Get an AccessPolicy by name.

+

Returns an access policy based on the name.

+

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

+

Gets the IAM policy for the specified Access Context Manager access policy.

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

-

List all AccessPolicies under a container.

+

Lists all access policies in an organization.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.

+

Updates an access policy. The long-running operation from this RPC has a successful status after the changes to the access policy propagate to long-lasting storage.

+

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

+

Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy.

+

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

+

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Method Details

close() @@ -113,7 +122,7 @@

Method Details

create(body=None, x__xgafv=None) -
Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
+  
Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto.
 
 Args:
   body: object, The request body.
@@ -123,6 +132,9 @@ 

Method Details

"etag": "A String", # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` + "scopes": [ # The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` + "A String", + ], "title": "A String", # Required. Human readable title. Does not affect behavior. } @@ -157,7 +169,7 @@

Method Details

delete(name, x__xgafv=None) -
Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.
+  
Deletes an access policy based on the resource name. The long-running operation has a successful status after the access policy is removed from long-lasting storage.
 
 Args:
   name: string, Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}` (required)
@@ -192,7 +204,7 @@ 

Method Details

get(name, x__xgafv=None) -
Get an AccessPolicy by name.
+  
Returns an access policy based on the name.
 
 Args:
   name: string, Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}` (required)
@@ -208,13 +220,72 @@ 

Method Details

"etag": "A String", # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` + "scopes": [ # The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` + "A String", + ], "title": "A String", # Required. Human readable title. Does not affect behavior. }
+
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the IAM policy for the specified Access Context Manager access policy.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # 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.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # 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.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # 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.
+      },
+      "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `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.
+  "version": 42, # 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).
+}
+
+
list(pageSize=None, pageToken=None, parent=None, x__xgafv=None) -
List all AccessPolicies under a container.
+  
Lists all access policies in an organization.
 
 Args:
   pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
@@ -234,6 +305,9 @@ 

Method Details

"etag": "A String", # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` + "scopes": [ # The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` + "A String", + ], "title": "A String", # Required. Human readable title. Does not affect behavior. }, ], @@ -257,7 +331,7 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
+  
Updates an access policy. The long-running operation from this RPC has a successful status after the changes to the access policy propagate to long-lasting storage.
 
 Args:
   name: string, Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` (required)
@@ -268,6 +342,9 @@ 

Method Details

"etag": "A String", # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` + "scopes": [ # The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` + "A String", + ], "title": "A String", # Required. Human readable title. Does not affect behavior. } @@ -301,4 +378,119 @@

Method Details

}
+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # 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.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # 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.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # 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.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # 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.
+        },
+        "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+      },
+    ],
+    "etag": "A String", # `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.
+    "version": 42, # 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).
+  },
+  "updateMask": "A String", # 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"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # 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.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # 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.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # 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.
+      },
+      "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `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.
+  "version": 42, # 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).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # 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).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index e8b7f14c08b..bab500a7afe 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -79,28 +79,31 @@

Instance Methods

Close httplib2 connections.

commit(parent, body=None, x__xgafv=None)

-

Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its `spec` field to that Service Perimeter's `status` field. Only Service Perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will be cleared after a successful commit operation.

+

Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its `spec` field to the `status` field of the service perimeter. Only service perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are cleared after a successful commit operation.

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

-

Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.

+

Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.

delete(name, x__xgafv=None)

-

Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.

+

Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage.

get(name, x__xgafv=None)

-

Get a Service Perimeter by resource name.

+

Gets a service perimeter based on the resource name.

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

-

List all Service Perimeters for an access policy.

+

Lists all service perimeters for an access policy.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.

+

Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.

replaceAll(parent, body=None, x__xgafv=None)

-

Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse.

+

Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.

+

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

+

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Method Details

close() @@ -109,7 +112,7 @@

Method Details

commit(parent, body=None, x__xgafv=None) -
Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its `spec` field to that Service Perimeter's `status` field. Only Service Perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will be cleared after a successful commit operation.
+  
Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its `spec` field to the `status` field of the service perimeter. Only service perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are cleared after a successful commit operation.
 
 Args:
   parent: string, Required. Resource name for the parent Access Policy which owns all Service Perimeters in scope for the commit operation. Format: `accessPolicies/{policy_id}` (required)
@@ -151,7 +154,7 @@ 

Method Details

create(parent, body=None, x__xgafv=None) -
Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.
+  
Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.
 
 Args:
   parent: string, Required. Resource name for the access policy which owns this Service Perimeter. Format: `accessPolicies/{policy_id}` (required)
@@ -347,7 +350,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.
+  
Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage.
 
 Args:
   name: string, Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` (required)
@@ -382,7 +385,7 @@ 

Method Details

get(name, x__xgafv=None) -
Get a Service Perimeter by resource name.
+  
Gets a service perimeter based on the resource name.
 
 Args:
   name: string, Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` (required)
@@ -555,7 +558,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
List all Service Perimeters for an access policy.
+  
Lists all service perimeters for an access policy.
 
 Args:
   parent: string, Required. Resource name for the access policy to list Service Perimeters from. Format: `accessPolicies/{policy_id}` (required)
@@ -749,7 +752,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.
+  
Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.
 
 Args:
   name: string, Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}` (required)
@@ -946,7 +949,7 @@ 

Method Details

replaceAll(parent, body=None, x__xgafv=None) -
Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse.
+  
Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.
 
 Args:
   parent: string, Required. Resource name for the access policy which owns these Service Perimeters. Format: `accessPolicies/{policy_id}` (required)
@@ -1145,4 +1148,34 @@ 

Method Details

}
+
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # 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).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html index 73addb6de9b..7ed46a216d4 100644 --- a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html +++ b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a GcpUserAccessBinding. If the client specifies a name, the server will ignore it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

+

Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

delete(name, x__xgafv=None)

Deletes a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

@@ -103,7 +103,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a GcpUserAccessBinding. If the client specifies a name, the server will ignore it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.
+  
Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.
 
 Args:
   parent: string, Required. Example: "organizations/256" (required)
diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html
index 88bcdb1255e..66c631018f5 100644
--- a/docs/dyn/admin_directory_v1.chromeosdevices.html
+++ b/docs/dyn/admin_directory_v1.chromeosdevices.html
@@ -231,6 +231,7 @@ 

Method Details

"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API, and this will be supported in the future. "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osVersion": "A String", # The Chrome device's operating system version. "platformVersion": "A String", # The Chrome device's platform version. @@ -289,7 +290,7 @@

Method Details

serialNumber - The Chrome device serial number entered when the device was enabled. status - Chrome device status. For more information, see the <a [chromeosdevices](/admin-sdk/directory/v1/reference/chromeosdevices.html). supportEndDate - Chrome device support end date. This is applicable only for devices purchased directly from Google. - orgUnitPath: string, The full path of the organizational unit or its unique ID. + orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. pageToken: string, The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response. projection: string, Restrict information returned to a set of selected fields. Allowed values @@ -396,6 +397,7 @@

Method Details

"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API, and this will be supported in the future. "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osVersion": "A String", # The Chrome device's operating system version. "platformVersion": "A String", # The Chrome device's platform version. @@ -575,6 +577,7 @@

Method Details

"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API, and this will be supported in the future. "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osVersion": "A String", # The Chrome device's operating system version. "platformVersion": "A String", # The Chrome device's platform version. @@ -713,6 +716,7 @@

Method Details

"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API, and this will be supported in the future. "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osVersion": "A String", # The Chrome device's operating system version. "platformVersion": "A String", # The Chrome device's platform version. @@ -850,6 +854,7 @@

Method Details

"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API, and this will be supported in the future. "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osVersion": "A String", # The Chrome device's operating system version. "platformVersion": "A String", # The Chrome device's platform version. @@ -988,6 +993,7 @@

Method Details

"model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API, and this will be supported in the future. "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osVersion": "A String", # The Chrome device's operating system version. "platformVersion": "A String", # The Chrome device's platform version. diff --git a/docs/dyn/admin_directory_v1.mobiledevices.html b/docs/dyn/admin_directory_v1.mobiledevices.html index 02179af1e57..7e2ec22aba8 100644 --- a/docs/dyn/admin_directory_v1.mobiledevices.html +++ b/docs/dyn/admin_directory_v1.mobiledevices.html @@ -88,7 +88,7 @@

Instance Methods

Retrieves a mobile device's properties.

list(customerId, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None)

-

Retrieves a paginated list of all mobile devices for an account.

+

Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -214,7 +214,7 @@

Method Details

list(customerId, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None) -
Retrieves a paginated list of all mobile devices for an account.
+  
Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead.
 
 Args:
   customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
diff --git a/docs/dyn/admin_directory_v1.orgunits.html b/docs/dyn/admin_directory_v1.orgunits.html
index 94a7de9be86..617669175e0 100644
--- a/docs/dyn/admin_directory_v1.orgunits.html
+++ b/docs/dyn/admin_directory_v1.orgunits.html
@@ -107,7 +107,7 @@ 

Method Details

Args: customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - orgUnitPath: string, The full path of the organizational unit or its unique ID. (required) + orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -121,7 +121,7 @@

Method Details

Args: customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - orgUnitPath: string, The full path of the organizational unit or its unique ID. (required) + orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -229,7 +229,7 @@

Method Details

Args: customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - orgUnitPath: string, The full path of the organizational unit or its unique ID. (required) + orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required) body: object, The request body. The object takes the form of: @@ -272,7 +272,7 @@

Method Details

Args: customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - orgUnitPath: string, The full path of the organizational unit or its unique ID. (required) + orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required) body: object, The request body. The object takes the form of: diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html index a6dff84ad9a..17170201194 100644 --- a/docs/dyn/admin_reports_v1.activities.html +++ b/docs/dyn/admin_reports_v1.activities.html @@ -112,9 +112,9 @@

Method Details

jamboard - The Jamboard activity reports return information about various Jamboard activity events. login - The Login application's activity reports return account information about different types of Login activity events. meet - The Meet Audit activity report returns information about different types of Meet Audit activity events. - mobile - The Mobile Audit activity report return information about different types of Mobile Audit activity events. - rules - The Rules activity report return information about different types of Rules activity events. - saml - The SAML activity report return information about different types of SAML activity events. + mobile - The Device Audit activity report returns information about different types of Device Audit activity events. + rules - The Rules activity report returns information about different types of Rules activity events. + saml - The SAML activity report returns information about different types of SAML activity events. token - The Token application's activity reports return account information about different types of Token activity events. user_accounts - The User Accounts application's activity reports return account information about different types of User Accounts activity events. context_aware_access - The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules. @@ -260,9 +260,9 @@

Method Details

jamboard - The Jamboard activity reports return information about various Jamboard activity events. login - The Login application's activity reports return account information about different types of Login activity events. meet - The Meet Audit activity report returns information about different types of Meet Audit activity events. - mobile - The Mobile Audit activity report return information about different types of Mobile Audit activity events. - rules - The Rules activity report return information about different types of Rules activity events. - saml - The SAML activity report return information about different types of SAML activity events. + mobile - The Device Audit activity report returns information about different types of Device Audit activity events. + rules - The Rules activity report returns information about different types of Rules activity events. + saml - The SAML activity report returns information about different types of SAML activity events. token - The Token application's activity reports return account information about different types of Token activity events. user_accounts - The User Accounts application's activity reports return account information about different types of User Accounts activity events. context_aware_access - The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules. diff --git a/docs/dyn/admin_reports_v1.entityUsageReports.html b/docs/dyn/admin_reports_v1.entityUsageReports.html index fdb12bda6b8..488998926c3 100644 --- a/docs/dyn/admin_reports_v1.entityUsageReports.html +++ b/docs/dyn/admin_reports_v1.entityUsageReports.html @@ -97,10 +97,7 @@

Method Details

entityType: string, Represents the type of entity for the report. (required) Allowed values gplus_communities - Returns a report on Google+ communities. - entityKey: string, Represents the key of the object to filter the data with. (required) - Allowed values - all - Returns activity events for all users. - entityKey - Represents an app-specific identifier for the entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides. + entityKey: string, Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides. (required) date: string, Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. (required) customerId: string, The unique ID of the customer to retrieve data for. filters: string, The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters. diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 05b10f199ea..04257e281b9 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -377,6 +377,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. }, "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history. @@ -500,6 +503,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. }, "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html b/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html index 04244525a6c..5a937b203f0 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.customMetrics.html @@ -140,6 +140,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. } @@ -157,6 +160,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. }
@@ -181,6 +187,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. }
@@ -209,6 +218,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. }, ], @@ -245,6 +257,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. } @@ -263,6 +278,9 @@

Method Details

"measurementUnit": "A String", # Required. The type for the custom metric's value. "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. + "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. + "A String", + ], "scope": "A String", # Required. Immutable. The scope of this custom metric. }
diff --git a/docs/dyn/analyticsdata_v1beta.properties.html b/docs/dyn/analyticsdata_v1beta.properties.html index eb7b49c779a..cd86c273ae5 100644 --- a/docs/dyn/analyticsdata_v1beta.properties.html +++ b/docs/dyn/analyticsdata_v1beta.properties.html @@ -146,7 +146,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -185,7 +185,7 @@

Method Details

}, }, "dimensions": [ # The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys. - { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. + { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. "dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". @@ -210,7 +210,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -340,6 +340,7 @@

Method Details

}, ], }, + "subjectToThresholding": True or False, # If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357). "timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". }, "metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. @@ -450,7 +451,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -489,7 +490,7 @@

Method Details

}, }, "dimensions": [ # The dimensions requested and displayed. - { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. + { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. "dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". @@ -512,13 +513,13 @@

Method Details

"metricAggregations": [ # Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". "A String", ], - "metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter. + "metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship. "expressions": [ # A list of filter expressions. # Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -637,6 +638,7 @@

Method Details

}, ], }, + "subjectToThresholding": True or False, # If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357). "timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". }, "metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. @@ -732,7 +734,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -771,7 +773,7 @@

Method Details

}, }, "dimensions": [ # The dimensions in this report. `dimensions` should be the same value as in your `runReport` request. - { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. + { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. "dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". @@ -795,7 +797,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -987,7 +989,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -1026,7 +1028,7 @@

Method Details

}, }, "dimensions": [ # The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys. - { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. + { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. "dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". @@ -1051,7 +1053,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -1176,6 +1178,7 @@

Method Details

}, ], }, + "subjectToThresholding": True or False, # If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357). "timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". }, "metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. @@ -1253,7 +1256,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -1292,7 +1295,7 @@

Method Details

}, }, "dimensions": [ # The dimensions requested and displayed. - { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. + { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. "dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". @@ -1320,7 +1323,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -1544,7 +1547,7 @@

Method Details

# Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -1583,7 +1586,7 @@

Method Details

}, }, "dimensions": [ # The dimensions requested and displayed. - { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. + { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. "dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". @@ -1606,13 +1609,13 @@

Method Details

"metricAggregations": [ # Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". "A String", ], - "metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter. + "metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship. "expressions": [ # A list of filter expressions. # Object with schema name: FilterExpression ], }, - "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics. + "filter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values. "fromValue": { # To represent a number. # Begins with this number. "doubleValue": 3.14, # Double value @@ -1726,6 +1729,7 @@

Method Details

}, ], }, + "subjectToThresholding": True or False, # If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357). "timeZone": "A String", # The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". }, "metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. diff --git a/docs/dyn/apigee_v1.organizations.apps.html b/docs/dyn/apigee_v1.organizations.apps.html index 2e09a351085..5d87b221054 100644 --- a/docs/dyn/apigee_v1.organizations.apps.html +++ b/docs/dyn/apigee_v1.organizations.apps.html @@ -107,7 +107,7 @@

Method Details

"apiProducts": [ # List of API products associated with the app. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "appId": "A String", # ID of the app. @@ -125,7 +125,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -184,7 +184,7 @@

Method Details

"apiProducts": [ # List of API products associated with the app. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "appId": "A String", # ID of the app. @@ -202,7 +202,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. diff --git a/docs/dyn/apigee_v1.organizations.developers.apps.html b/docs/dyn/apigee_v1.organizations.developers.apps.html index 6f9e4ec90b3..d4bb85344dc 100644 --- a/docs/dyn/apigee_v1.organizations.developers.apps.html +++ b/docs/dyn/apigee_v1.organizations.developers.apps.html @@ -139,7 +139,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -195,7 +195,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -258,7 +258,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -316,7 +316,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -373,7 +373,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -438,7 +438,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -507,7 +507,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -567,7 +567,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. @@ -623,7 +623,7 @@

Method Details

"apiProducts": [ # List of API products this credential can be used for. { "apiproduct": "A String", # Name of the API product. - "status": "A String", # Status of the API product. + "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. }, ], "attributes": [ # List of attributes associated with this credential. diff --git a/docs/dyn/apigee_v1.organizations.developers.balance.html b/docs/dyn/apigee_v1.organizations.developers.balance.html index 0d6c886f5b7..63a97f541c6 100644 --- a/docs/dyn/apigee_v1.organizations.developers.balance.html +++ b/docs/dyn/apigee_v1.organizations.developers.balance.html @@ -74,6 +74,9 @@

Apigee API . organizations . developers . balance

Instance Methods

+

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

+

Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.

close()

Close httplib2 connections.

@@ -81,6 +84,45 @@

Instance Methods

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

Credits the account balance for the developer.

Method Details

+
+ adjust(name, body=None, x__xgafv=None) +
Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.
+
+Args:
+  name: string, Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for AdjustDeveloperBalance.
+  "adjustment": { # Represents an amount of money with its currency type. # * A positive value of `adjustment` means that that the API provider wishes to adjust the balance for an over-charged developer i.e. the balance of the developer will increase. * A negative value of `adjustment` means that that the API provider wishes to adjust the balance for an under-charged developer i.e. the balance of the developer will decrease.
+    "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+    "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+    "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Account balance for the developer.
+  "wallets": [ # Output only. List of all wallets. Each individual wallet stores the account balance for a particular currency.
+    { # Wallet used to manage an account balance for a particular currency.
+      "balance": { # Represents an amount of money with its currency type. # Current remaining balance of the developer for a particular currency.
+        "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+        "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+        "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+      },
+      "lastCreditTime": "A String", # Output only. Time at which the developer last added credit to the account in milliseconds since epoch.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index 51c097fabf1..4d952b25589 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -505,7 +505,8 @@

Method Details

"organizations": [ # List of Apigee organizations and associated GCP projects. { "organization": "A String", # Name of the Apigee organization. - "projectIds": [ # List of GCP projects associated with the Apigee organization. + "projectId": "A String", # GCP project associated with the Apigee organization + "projectIds": [ # DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a single project. "A String", ], }, diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.html index e8b8c9e5a79..2f8f04d49c2 100644 --- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.html @@ -125,7 +125,7 @@

Method Details

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.
 
 Args:
-  parent: string, The name of the parent resource where the repository will be created. (required)
+  parent: string, Required. The name of the parent resource where the repository will be created. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -176,7 +176,7 @@ 

Method Details

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.
 
 Args:
-  name: string, The name of the repository to delete. (required)
+  name: string, Required. The name of the repository to delete. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -211,7 +211,7 @@ 

Method Details

Gets a repository.
 
 Args:
-  name: string, The name of the repository to retrieve. (required)
+  name: string, Required. The name of the repository to retrieve. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -273,7 +273,7 @@ 

Method Details

Lists repositories.
 
 Args:
-  parent: string, The name of the parent resource whose repositories will be listed. (required)
+  parent: string, Required. The name of the parent resource whose repositories will be listed. (required)
   pageSize: integer, The maximum number of repositories to return.
   pageToken: string, The next_page_token value returned from a previous list request, if any.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.html
index 37f151da840..b63365611f6 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.html
+++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.html
@@ -110,7 +110,7 @@ 

Method Details

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
 
 Args:
-  name: string, The name of the package to delete. (required)
+  name: string, Required. The name of the package to delete. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -145,7 +145,7 @@ 

Method Details

Gets a package.
 
 Args:
-  name: string, The name of the package to retrieve. (required)
+  name: string, Required. The name of the package to retrieve. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,7 +167,7 @@ 

Method Details

Lists packages.
 
 Args:
-  parent: string, The name of the parent resource whose packages will be listed. (required)
+  parent: string, Required. The name of the parent resource whose packages will be listed. (required)
   pageSize: integer, The maximum number of packages to return.
   pageToken: string, The next_page_token value returned from a previous list request, if any.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html
index 2e84ee5293d..87b9cbe14aa 100644
--- a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html
+++ b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html
@@ -115,7 +115,9 @@ 

Method Details

"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. + "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. @@ -138,6 +140,12 @@

Method Details

"resourceType": "A String", # Indicates the type of resource. }, ], + "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page. + "setupErrors": [ # Indicates SAA enrollment setup error if any. + "A String", + ], + "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. + }, } externalId: string, Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value. @@ -208,7 +216,9 @@

Method Details

"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. + "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. @@ -231,6 +241,12 @@

Method Details

"resourceType": "A String", # Indicates the type of resource. }, ], + "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page. + "setupErrors": [ # Indicates SAA enrollment setup error if any. + "A String", + ], + "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. + }, }
@@ -259,7 +275,9 @@

Method Details

"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. + "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. @@ -282,6 +300,12 @@

Method Details

"resourceType": "A String", # Indicates the type of resource. }, ], + "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page. + "setupErrors": [ # Indicates SAA enrollment setup error if any. + "A String", + ], + "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. + }, }, ], }
@@ -315,7 +339,9 @@

Method Details

"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. + "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. @@ -338,6 +364,12 @@

Method Details

"resourceType": "A String", # Indicates the type of resource. }, ], + "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page. + "setupErrors": [ # Indicates SAA enrollment setup error if any. + "A String", + ], + "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. + }, } updateMask: string, Required. The list of fields to be updated. @@ -354,7 +386,9 @@

Method Details

"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. + "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. @@ -377,6 +411,12 @@

Method Details

"resourceType": "A String", # Indicates the type of resource. }, ], + "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page. + "setupErrors": [ # Indicates SAA enrollment setup error if any. + "A String", + ], + "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. + }, }
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html index 05c2e8e04c8..5d72daf8824 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html @@ -239,7 +239,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html index 3257ff842da..1ec842785f5 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a cluster within an instance.

+

Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

delete(name, x__xgafv=None)

Deletes a cluster from an instance.

@@ -99,10 +99,10 @@

Instance Methods

Retrieves the next page of results.

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

-

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

+

Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

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

-

Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.

+

Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Method Details

close() @@ -111,7 +111,7 @@

Method Details

create(parent, body=None, clusterId=None, x__xgafv=None) -
Creates a cluster within an instance.
+  
Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
 
 Args:
   parent: string, Required. The unique name of the instance in which to create the new cluster. Values are of the form `projects/{project}/instances/{instance}`. (required)
@@ -120,7 +120,7 @@ 

Method Details

{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. "clusterConfig": { # Configuration for a cluster. # Configuration for this cluster. - "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled. + "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. "autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster. "maxServeNodes": 42, # Required. Maximum number of nodes to scale up to. "minServeNodes": 42, # Required. Minimum number of nodes to scale down to. @@ -136,7 +136,7 @@

Method Details

}, "location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`. "name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. - "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. + "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. "state": "A String", # Output only. The current state of the cluster. } @@ -204,7 +204,7 @@

Method Details

{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. "clusterConfig": { # Configuration for a cluster. # Configuration for this cluster. - "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled. + "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. "autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster. "maxServeNodes": 42, # Required. Maximum number of nodes to scale up to. "minServeNodes": 42, # Required. Minimum number of nodes to scale down to. @@ -220,7 +220,7 @@

Method Details

}, "location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`. "name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. - "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. + "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. "state": "A String", # Output only. The current state of the cluster. }
@@ -244,7 +244,7 @@

Method Details

"clusters": [ # The list of requested clusters. { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. "clusterConfig": { # Configuration for a cluster. # Configuration for this cluster. - "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled. + "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. "autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster. "maxServeNodes": 42, # Required. Maximum number of nodes to scale up to. "minServeNodes": 42, # Required. Minimum number of nodes to scale down to. @@ -260,7 +260,7 @@

Method Details

}, "location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`. "name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. - "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. + "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. "state": "A String", # Output only. The current state of the cluster. }, ], @@ -287,7 +287,7 @@

Method Details

partialUpdateCluster(name, body=None, updateMask=None, x__xgafv=None) -
Partially updates a cluster within a project. This method is the preferred way to update a Cluster. 
+  
Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.
 
 Args:
   name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
@@ -296,7 +296,7 @@ 

Method Details

{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. "clusterConfig": { # Configuration for a cluster. # Configuration for this cluster. - "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled. + "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. "autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster. "maxServeNodes": 42, # Required. Maximum number of nodes to scale up to. "minServeNodes": 42, # Required. Minimum number of nodes to scale down to. @@ -312,11 +312,11 @@

Method Details

}, "location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`. "name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. - "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. + "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. "state": "A String", # Output only. The current state of the cluster. } - updateMask: string, Required. The subset of Cluster fields which should be replaced. Must be explicitly set. + updateMask: string, Required. The subset of Cluster fields which should be replaced. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -348,7 +348,7 @@

Method Details

update(name, body=None, x__xgafv=None) -
Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.
+  
Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.
 
 Args:
   name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
@@ -357,7 +357,7 @@ 

Method Details

{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. "clusterConfig": { # Configuration for a cluster. # Configuration for this cluster. - "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled. + "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. "autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster. "maxServeNodes": 42, # Required. Maximum number of nodes to scale up to. "minServeNodes": 42, # Required. Minimum number of nodes to scale down to. @@ -373,7 +373,7 @@

Method Details

}, "location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`. "name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. - "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. + "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. "state": "A String", # Output only. The current state of the cluster. } diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.html b/docs/dyn/bigtableadmin_v2.projects.instances.html index eddd29d4595..7999794b975 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.html @@ -94,7 +94,7 @@

Instance Methods

Close httplib2 connections.

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

-

Create an instance within a project.

+

Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

delete(name, x__xgafv=None)

Delete an instance from a project.

@@ -130,7 +130,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Create an instance within a project.
+  
Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
 
 Args:
   parent: string, Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`. (required)
@@ -141,7 +141,7 @@ 

Method Details

"clusters": { # Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most four clusters can be specified. "a_key": { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. "clusterConfig": { # Configuration for a cluster. # Configuration for this cluster. - "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled. + "clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. "autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster. "maxServeNodes": 42, # Required. Maximum number of nodes to scale up to. "minServeNodes": 42, # Required. Minimum number of nodes to scale down to. @@ -157,7 +157,7 @@

Method Details

}, "location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`. "name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. - "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. + "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. "state": "A String", # Output only. The current state of the cluster. }, }, @@ -259,7 +259,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 736e7b451ec..5778a7d7141 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -433,7 +433,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/chat_v1.dms.conversations.html b/docs/dyn/chat_v1.dms.conversations.html index 273a1adfbb7..e98bf723ba8 100644 --- a/docs/dyn/chat_v1.dms.conversations.html +++ b/docs/dyn/chat_v1.dms.conversations.html @@ -631,9 +631,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -647,9 +647,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -835,13 +835,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -1406,9 +1409,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -1422,9 +1425,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -1610,13 +1613,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. diff --git a/docs/dyn/chat_v1.dms.html b/docs/dyn/chat_v1.dms.html index 2da941364d8..06b1bb05aa0 100644 --- a/docs/dyn/chat_v1.dms.html +++ b/docs/dyn/chat_v1.dms.html @@ -639,9 +639,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -655,9 +655,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -843,13 +843,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -1414,9 +1417,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -1430,9 +1433,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -1618,13 +1621,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -2189,9 +2195,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -2205,9 +2211,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -2393,13 +2399,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -2964,9 +2973,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -2980,9 +2989,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -3168,13 +3177,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. diff --git a/docs/dyn/chat_v1.rooms.conversations.html b/docs/dyn/chat_v1.rooms.conversations.html index eb672204151..e348508d21a 100644 --- a/docs/dyn/chat_v1.rooms.conversations.html +++ b/docs/dyn/chat_v1.rooms.conversations.html @@ -631,9 +631,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -647,9 +647,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -835,13 +835,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -1406,9 +1409,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -1422,9 +1425,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -1610,13 +1613,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. diff --git a/docs/dyn/chat_v1.rooms.html b/docs/dyn/chat_v1.rooms.html index 14b0957ddad..b5971bd89d1 100644 --- a/docs/dyn/chat_v1.rooms.html +++ b/docs/dyn/chat_v1.rooms.html @@ -639,9 +639,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -655,9 +655,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -843,13 +843,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -1414,9 +1417,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -1430,9 +1433,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -1618,13 +1621,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -2189,9 +2195,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -2205,9 +2211,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -2393,13 +2399,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -2964,9 +2973,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -2980,9 +2989,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -3168,13 +3177,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index cad4fd11ff8..1135993d0b1 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -716,9 +716,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -732,9 +732,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -920,13 +920,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -1491,9 +1494,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -1507,9 +1510,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -1695,13 +1698,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. diff --git a/docs/dyn/chat_v1.spaces.members.html b/docs/dyn/chat_v1.spaces.members.html index 3c825133b8f..58f7253f1db 100644 --- a/docs/dyn/chat_v1.spaces.members.html +++ b/docs/dyn/chat_v1.spaces.members.html @@ -108,11 +108,11 @@

Method Details

{ # Represents a membership relation in Google Chat. "createTime": "A String", # Output only. The creation time of the membership a.k.a. the time at which the member joined the space, if applicable. - "member": { # A user in Google Chat. # A user in Google Chat. + "member": { # A user in Google Chat. # A user in Google Chat. Represents a person in the People API. Formatted as `users/person_id` where `person_id` is available from the [People API](https://developers.google.com/people/api/rest/v1/people). "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "name": "A String", @@ -140,11 +140,11 @@

Method Details

"memberships": [ # List of memberships in the requested (or first) page. { # Represents a membership relation in Google Chat. "createTime": "A String", # Output only. The creation time of the membership a.k.a. the time at which the member joined the space, if applicable. - "member": { # A user in Google Chat. # A user in Google Chat. + "member": { # A user in Google Chat. # A user in Google Chat. Represents a person in the People API. Formatted as `users/person_id` where `person_id` is available from the [People API](https://developers.google.com/people/api/rest/v1/people). "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "name": "A String", diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index e7816c10c55..0b911dbaa3a 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -645,9 +645,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -661,9 +661,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -849,13 +849,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -1420,9 +1423,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -1436,9 +1439,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -1624,13 +1627,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -2218,9 +2224,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -2234,9 +2240,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -2422,13 +2428,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -2993,9 +3002,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -3009,9 +3018,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -3197,13 +3206,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. @@ -3767,9 +3779,9 @@

Method Details

"slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. "bot": { # A user in Google Chat. # The bot whose command was invoked. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "commandId": "A String", # The command id of the invoked slash command. @@ -3783,9 +3795,9 @@

Method Details

"type": "A String", # The type of user mention. "user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, }, @@ -3971,13 +3983,16 @@

Method Details

"createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. + "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "url": "A String", # The url that was matched. + }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. "sender": { # A user in Google Chat. # The user who created the message. "displayName": "A String", # The user's display name. - "domainId": "A String", # Obfuscated domain information. + "domainId": "A String", # Unique identifier of the user's Google Workspace domain. "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. - "name": "A String", # Resource name, in the format "users/*". + "name": "A String", # Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API. "type": "A String", # User type. }, "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. diff --git a/docs/dyn/civicinfo_v2.representatives.html b/docs/dyn/civicinfo_v2.representatives.html index 20469123c3b..8e71054fea4 100644 --- a/docs/dyn/civicinfo_v2.representatives.html +++ b/docs/dyn/civicinfo_v2.representatives.html @@ -194,6 +194,20 @@

Method Details

"emails": [ # The direct email addresses for the official. "A String", ], + "geocodingSummaries": [ # Detailed summary about the official's address's geocoding + { # Detailed summary of the result from geocoding an address + "addressUnderstood": True or False, # Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto. + "featureId": { # A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit "cell id" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. # The ID of the FeatureProto returned by the geocoder + "cellId": "A String", # The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way. + "fprint": "A String", # A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient. + "temporaryData": { # This is proto2's version of MessageSet. # A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts. + }, + }, + "featureType": "A String", # The feature type for the FeatureProto returned by the geocoder + "positionPrecisionMeters": 3.14, # Precision of the center point (lat/long) of the geocoded FeatureProto + "queryString": "A String", # The query sent to the geocoder + }, + ], "name": "A String", # The official's name. "party": "A String", # The full name of the party the official belongs to. "phones": [ # The official's public contact phone numbers. @@ -303,6 +317,20 @@

Method Details

"emails": [ # The direct email addresses for the official. "A String", ], + "geocodingSummaries": [ # Detailed summary about the official's address's geocoding + { # Detailed summary of the result from geocoding an address + "addressUnderstood": True or False, # Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto. + "featureId": { # A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit "cell id" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. # The ID of the FeatureProto returned by the geocoder + "cellId": "A String", # The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way. + "fprint": "A String", # A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient. + "temporaryData": { # This is proto2's version of MessageSet. # A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts. + }, + }, + "featureType": "A String", # The feature type for the FeatureProto returned by the geocoder + "positionPrecisionMeters": 3.14, # Precision of the center point (lat/long) of the geocoded FeatureProto + "queryString": "A String", # The query sent to the geocoder + }, + ], "name": "A String", # The official's name. "party": "A String", # The full name of the party the official belongs to. "phones": [ # The official's public contact phone numbers. diff --git a/docs/dyn/cloudbilling_v1.projects.html b/docs/dyn/cloudbilling_v1.projects.html index 189b70e1bd1..a9a39e4d283 100644 --- a/docs/dyn/cloudbilling_v1.projects.html +++ b/docs/dyn/cloudbilling_v1.projects.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

getBillingInfo(name, x__xgafv=None)

-

Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).

+

Gets the billing information for a project. The current authenticated user must have the `resourcemanager.projects.get` permission for the project, which can be granted by assigning the [Project Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) role.

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

Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Cloud Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://cloud.google.com/billing/docs/how-to/billing-access). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.

@@ -91,7 +91,7 @@

Method Details

getBillingInfo(name, x__xgafv=None) -
Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).
+  
Gets the billing information for a project. The current authenticated user must have the `resourcemanager.projects.get` permission for the project, which can be granted by assigning the [Project Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) role.
 
 Args:
   name: string, Required. The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. (required)
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
index 94e4d5e1633..8a9facccaff 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html
@@ -178,6 +178,7 @@ 

Method Details

}, "targetRenders": { # Output only. Map from target ID to details of the render operation for that target. "a_key": { # Details of rendering for a single target. + "failureCause": "A String", # Output only. Reason this render failed. This will always be unspecified while the render in progress. "renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`. "renderingState": "A String", # Output only. Current state of the render operation for this Target. }, @@ -337,6 +338,7 @@

Method Details

}, "targetRenders": { # Output only. Map from target ID to details of the render operation for that target. "a_key": { # Details of rendering for a single target. + "failureCause": "A String", # Output only. Reason this render failed. This will always be unspecified while the render in progress. "renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`. "renderingState": "A String", # Output only. Current state of the render operation for this Target. }, @@ -472,6 +474,7 @@

Method Details

}, "targetRenders": { # Output only. Map from target ID to details of the render operation for that target. "a_key": { # Details of rendering for a single target. + "failureCause": "A String", # Output only. Reason this render failed. This will always be unspecified while the render in progress. "renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`. "renderingState": "A String", # Output only. Current state of the render operation for this Target. }, diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html index 5a25981dd7f..7828380fe37 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html @@ -140,6 +140,7 @@

Method Details

"approveTime": "A String", # Output only. Time at which the `Rollout` was approved. "createTime": "A String", # Output only. Time at which the `Rollout` was created. "deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying. + "deployFailureCause": "A String", # Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress. "deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying. "deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`. "description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters. @@ -209,6 +210,7 @@

Method Details

"approveTime": "A String", # Output only. Time at which the `Rollout` was approved. "createTime": "A String", # Output only. Time at which the `Rollout` was created. "deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying. + "deployFailureCause": "A String", # Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress. "deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying. "deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`. "description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters. @@ -254,6 +256,7 @@

Method Details

"approveTime": "A String", # Output only. Time at which the `Rollout` was approved. "createTime": "A String", # Output only. Time at which the `Rollout` was created. "deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying. + "deployFailureCause": "A String", # Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress. "deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying. "deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`. "description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters. diff --git a/docs/dyn/cloudidentity_v1.groups.html b/docs/dyn/cloudidentity_v1.groups.html index 27402fd7643..198943fb003 100644 --- a/docs/dyn/cloudidentity_v1.groups.html +++ b/docs/dyn/cloudidentity_v1.groups.html @@ -91,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Retrieves a `Group`.

+

+ getSecuritySettings(name, readMask=None, x__xgafv=None)

+

Get Security Settings

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

Lists the `Group` resources under a customer or namespace.

@@ -109,6 +112,9 @@

Instance Methods

search_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Update Security Settings

Method Details

close() @@ -263,6 +269,32 @@

Method Details

}
+
+ getSecuritySettings(name, readMask=None, x__xgafv=None) +
Get Security Settings
+
+Args:
+  name: string, Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` (required)
+  readMask: string, Field-level read mask of which fields to return. "*" returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The definition of security settings.
+  "memberRestriction": { # The definition of MemberRestriction # The Member Restriction value
+    "evaluation": { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
+      "state": "A String", # Output only. The current state of the restriction
+    },
+    "query": "A String", # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&&`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`
+  },
+  "name": "A String", # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
+}
+
+
list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)
Lists the `Group` resources under a customer or namespace.
@@ -488,4 +520,53 @@ 

Method Details

+
+ updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None) +
Update Security Settings
+
+Args:
+  name: string, Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The definition of security settings.
+  "memberRestriction": { # The definition of MemberRestriction # The Member Restriction value
+    "evaluation": { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
+      "state": "A String", # Output only. The current state of the restriction
+    },
+    "query": "A String", # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&&`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`
+  },
+  "name": "A String", # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
+}
+
+  updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.
+  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/cloudidentity_v1.groups.memberships.html b/docs/dyn/cloudidentity_v1.groups.memberships.html index a1139238557..e9ca32116ca 100644 --- a/docs/dyn/cloudidentity_v1.groups.memberships.html +++ b/docs/dyn/cloudidentity_v1.groups.memberships.html @@ -164,6 +164,11 @@

Method Details

"expireTime": "A String", # The time at which the `MembershipRole` will expire. }, "name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. + "restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership. + "memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation. + "state": "A String", # Output only. The current state of the restriction + }, + }, }, ], "type": "A String", # Output only. The type of the membership. @@ -261,6 +266,11 @@

Method Details

"expireTime": "A String", # The time at which the `MembershipRole` will expire. }, "name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. + "restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership. + "memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation. + "state": "A String", # Output only. The current state of the restriction + }, + }, }, ], "type": "A String", # Output only. The type of the membership. @@ -340,6 +350,11 @@

Method Details

"expireTime": "A String", # The time at which the `MembershipRole` will expire. }, "name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. + "restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership. + "memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation. + "state": "A String", # Output only. The current state of the restriction + }, + }, }, ], "type": "A String", # Output only. The type of the membership. @@ -401,6 +416,11 @@

Method Details

"expireTime": "A String", # The time at which the `MembershipRole` will expire. }, "name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. + "restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership. + "memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation. + "state": "A String", # Output only. The current state of the restriction + }, + }, }, ], "removeRoles": [ # The `name`s of the `MembershipRole`s to be removed. Adding or removing roles in the same request as updating roles is not supported. It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to delete a `Membership`, call MembershipsService.DeleteMembership instead. Must not contain `MEMBER`. Must not be set if `update_roles_params` is set. @@ -414,6 +434,11 @@

Method Details

"expireTime": "A String", # The time at which the `MembershipRole` will expire. }, "name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. + "restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership. + "memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation. + "state": "A String", # Output only. The current state of the restriction + }, + }, }, }, ], @@ -441,6 +466,11 @@

Method Details

"expireTime": "A String", # The time at which the `MembershipRole` will expire. }, "name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. + "restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership. + "memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation. + "state": "A String", # Output only. The current state of the restriction + }, + }, }, ], "type": "A String", # Output only. The type of the membership. diff --git a/docs/dyn/cloudidentity_v1beta1.devices.html b/docs/dyn/cloudidentity_v1beta1.devices.html index 18cb24b67b0..7e18238eee8 100644 --- a/docs/dyn/cloudidentity_v1beta1.devices.html +++ b/docs/dyn/cloudidentity_v1beta1.devices.html @@ -177,8 +177,8 @@

Method Details

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device. "enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device. "encryptionState": "A String", # Output only. Device encryption state. - "endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. # Output only. Attributes specific to Endpoint Verification devices. - "certificateInfo": [ # Details of certificates. + "endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. https://cloud.google.com/endpoint-verification/docs/overview # Output only. Attributes specific to Endpoint Verification devices. + "certificateAttributes": [ # Details of certificates. { # Stores information about a certificate. "certificateTemplate": { # CertificateTemplate (v3 Extension in X.509). # The X.509 extension for CertificateTemplate. "id": "A String", # The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047". @@ -315,8 +315,8 @@

Method Details

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device. "enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device. "encryptionState": "A String", # Output only. Device encryption state. - "endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. # Output only. Attributes specific to Endpoint Verification devices. - "certificateInfo": [ # Details of certificates. + "endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. https://cloud.google.com/endpoint-verification/docs/overview # Output only. Attributes specific to Endpoint Verification devices. + "certificateAttributes": [ # Details of certificates. { # Stores information about a certificate. "certificateTemplate": { # CertificateTemplate (v3 Extension in X.509). # The X.509 extension for CertificateTemplate. "id": "A String", # The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047". @@ -399,8 +399,8 @@

Method Details

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device. "enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device. "encryptionState": "A String", # Output only. Device encryption state. - "endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. # Output only. Attributes specific to Endpoint Verification devices. - "certificateInfo": [ # Details of certificates. + "endpointVerificationSpecificAttributes": { # Resource representing the Endpoint Verification-specific attributes of a Device. https://cloud.google.com/endpoint-verification/docs/overview # Output only. Attributes specific to Endpoint Verification devices. + "certificateAttributes": [ # Details of certificates. { # Stores information about a certificate. "certificateTemplate": { # CertificateTemplate (v3 Extension in X.509). # The X.509 extension for CertificateTemplate. "id": "A String", # The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047". diff --git a/docs/dyn/cloudsearch_v1.debug.datasources.items.html b/docs/dyn/cloudsearch_v1.debug.datasources.items.html index a3828bb815b..e46e18d2fff 100644 --- a/docs/dyn/cloudsearch_v1.debug.datasources.items.html +++ b/docs/dyn/cloudsearch_v1.debug.datasources.items.html @@ -324,7 +324,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item. }, ], "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html index 06d0f44df71..640ab26b3d3 100644 --- a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html +++ b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html @@ -126,7 +126,7 @@

Method Details

UNSPECIFIED - Priority is not specified in the update request. Leaving priority unspecified results in an update failure. SYNCHRONOUS - For real-time updates. ASYNCHRONOUS - For changes that are executed after the response is sent back to the caller. - version: string, Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + version: string, Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -385,7 +385,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item. }
@@ -573,7 +573,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item. }, "mode": "A String", # Required. The RequestMode for this request. } @@ -795,7 +795,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item. }, ], "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. @@ -1014,7 +1014,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item. }, ], }
@@ -1224,7 +1224,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item. }
diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html index e598cdaec49..6c368d0ba48 100644 --- a/docs/dyn/cloudsearch_v1.query.html +++ b/docs/dyn/cloudsearch_v1.query.html @@ -392,6 +392,7 @@

Method Details

"name": "A String", # Source name for content indexed by the Indexing API. "predefinedSource": "A String", # Predefined content source for Google Apps. }, + "thumbnailUrl": "A String", # The thumbnail URL of the result. "updateTime": "A String", # The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time. }, "snippet": { # Snippet of the search result, which summarizes the content of the resulting page. # The concatenation of all snippets (summaries) available for this result. diff --git a/docs/dyn/cloudsearch_v1.settings.datasources.html b/docs/dyn/cloudsearch_v1.settings.datasources.html index db1412d10bb..65097d5d90f 100644 --- a/docs/dyn/cloudsearch_v1.settings.datasources.html +++ b/docs/dyn/cloudsearch_v1.settings.datasources.html @@ -127,6 +127,7 @@

Method Details

"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema. "A String", ], + "returnThumbnailUrls": True or False, # Can a user request to get thumbnail URI for Items indexed in this data source. "shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *<value>* then queries like *source:<value>* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. } @@ -228,6 +229,7 @@

Method Details

"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema. "A String", ], + "returnThumbnailUrls": True or False, # Can a user request to get thumbnail URI for Items indexed in this data source. "shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *<value>* then queries like *source:<value>* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. }
@@ -269,6 +271,7 @@

Method Details

"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema. "A String", ], + "returnThumbnailUrls": True or False, # Can a user request to get thumbnail URI for Items indexed in this data source. "shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *<value>* then queries like *source:<value>* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. }, ], @@ -320,6 +323,7 @@

Method Details

"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema. "A String", ], + "returnThumbnailUrls": True or False, # Can a user request to get thumbnail URI for Items indexed in this data source. "shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *<value>* then queries like *source:<value>* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. }, } diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html index a02ac62ab20..ad93fee9306 100644 --- a/docs/dyn/cloudsearch_v1.settings.searchapplications.html +++ b/docs/dyn/cloudsearch_v1.settings.searchapplications.html @@ -171,6 +171,7 @@

Method Details

"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results. "forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode. }, + "returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable) "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results. "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI. "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results. @@ -331,6 +332,7 @@

Method Details

"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results. "forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode. }, + "returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable) "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results. "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI. "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results. @@ -431,6 +433,7 @@

Method Details

"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results. "forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode. }, + "returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable) "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results. "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI. "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results. @@ -581,6 +584,7 @@

Method Details

"forceDisableSupplementalResults": True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results. "forceVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode. }, + "returnResultThumbnailUrls": True or False, # With each result we should return the URI for its thumbnail (when applicable) "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results. "disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI. "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will be used to boost results. diff --git a/docs/dyn/cloudsearch_v1.stats.html b/docs/dyn/cloudsearch_v1.stats.html index dde2940f290..ec8ac13b8c4 100644 --- a/docs/dyn/cloudsearch_v1.stats.html +++ b/docs/dyn/cloudsearch_v1.stats.html @@ -103,6 +103,9 @@

Instance Methods

getQuery(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)

Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.

+

+ getSearchapplication(endDate_day=None, endDate_month=None, endDate_year=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

+

Get search application stats for customer. **Note:** This API requires a standard end user account to execute.

getSession(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)

Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute.

@@ -135,6 +138,7 @@

Method Details

An object of the form: { + "averageIndexedItemCount": "A String", # Average item count for the given date range for which billing is done. "stats": [ # Summary of indexed item counts, one for each day in the requested range. { # Aggregation of items by status code as of the specified date. "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # Date for which statistics were calculated. @@ -145,6 +149,7 @@

Method Details

"itemCountByStatus": [ # Number of items aggregrated by status code. { "count": "A String", # Number of items matching the status code. + "indexedItemsCount": "A String", # Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code. "statusCode": "A String", # Status of the items. }, ], @@ -188,6 +193,41 @@

Method Details

], }, ], + "totalQueryCount": "A String", # Total successful query count (status code 200) for the given date range. +}
+
+ +
+ getSearchapplication(endDate_day=None, endDate_month=None, endDate_year=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None) +
Get search application stats for customer. **Note:** This API requires a standard end user account to execute.
+
+Args:
+  endDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
+  endDate_month: integer, Month of date. Must be from 1 to 12.
+  endDate_year: integer, Year of date. Must be from 1 to 9999.
+  startDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
+  startDate_month: integer, Month of date. Must be from 1 to 12.
+  startDate_year: integer, Year of date. Must be from 1 to 9999.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response format for search application stats for a customer.
+  "averageSearchApplicationCount": "A String", # Average search application count for the given date range.
+  "stats": [ # Search application stats by date.
+    { # Search application stats for a customer for the given date.
+      "count": "A String", # The count of search applications for the date.
+      "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # Date for which search application stats were calculated.
+        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+        "month": 42, # Month of date. Must be from 1 to 12.
+        "year": 42, # Year of date. Must be from 1 to 9999.
+      },
+    },
+  ],
 }
diff --git a/docs/dyn/cloudsearch_v1.stats.index.datasources.html b/docs/dyn/cloudsearch_v1.stats.index.datasources.html index db368a07af2..7618ccf735a 100644 --- a/docs/dyn/cloudsearch_v1.stats.index.datasources.html +++ b/docs/dyn/cloudsearch_v1.stats.index.datasources.html @@ -107,6 +107,7 @@

Method Details

An object of the form: { + "averageIndexedItemCount": "A String", # Average item count for the given date range for which billing is done. "stats": [ # Summary of indexed item counts, one for each day in the requested range. { # Aggregation of items by status code as of the specified date. "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # Date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned. @@ -117,6 +118,7 @@

Method Details

"itemCountByStatus": [ # Number of items aggregrated by status code. { "count": "A String", # Number of items matching the status code. + "indexedItemsCount": "A String", # Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code. "statusCode": "A String", # Status of the items. }, ], diff --git a/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html b/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html index 8bca0babab6..04411dff114 100644 --- a/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html +++ b/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html @@ -122,6 +122,7 @@

Method Details

], }, ], + "totalQueryCount": "A String", # Total successful query count (status code 200) for the given date range. }
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html index c10b33f3939..b08d9eaddd6 100644 --- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html @@ -267,7 +267,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html index 7d5becff0a5..e3675bd1b23 100644 --- a/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html +++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html @@ -146,7 +146,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -223,7 +223,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -329,7 +329,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -422,7 +422,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -528,7 +528,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html index eb4fabb4b4b..532c39bad38 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html @@ -301,7 +301,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html index 9a8a86f99c9..28e5a433837 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html @@ -304,7 +304,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html index 4fc2e3101a4..26872e5b1df 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html @@ -146,7 +146,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -227,7 +227,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -337,7 +337,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -434,7 +434,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. @@ -544,7 +544,7 @@

Method Details

}, "httpRequest": { # 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). # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. - "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when 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. + "headers": { # 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. "a_key": "A String", }, "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html index 6450d5e5542..80e7c7bb78f 100644 --- a/docs/dyn/compute_alpha.disks.html +++ b/docs/dyn/compute_alpha.disks.html @@ -88,7 +88,7 @@

Instance Methods

Close httplib2 connections.

createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)

-

Creates a snapshot of a specified persistent disk.

+

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

delete(project, zone, disk, requestId=None, x__xgafv=None)

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

@@ -124,7 +124,7 @@

Instance Methods

Returns permissions that a caller has on the specified resource.

update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

-

Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

+

Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

Method Details

addResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None) @@ -365,7 +365,7 @@

Method Details

createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None) -
Creates a snapshot of a specified persistent disk.
+  
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -412,6 +412,7 @@ 

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -1537,7 +1538,7 @@

Method Details

update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None) -
Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.
+  
Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.firewallPolicies.html b/docs/dyn/compute_alpha.firewallPolicies.html
index 7bbcb6e2047..8540c0e3f48 100644
--- a/docs/dyn/compute_alpha.firewallPolicies.html
+++ b/docs/dyn/compute_alpha.firewallPolicies.html
@@ -239,6 +239,9 @@ 

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -256,6 +259,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -529,6 +535,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -546,6 +555,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -733,6 +745,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -750,6 +765,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -820,6 +838,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -837,6 +858,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -986,6 +1010,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1003,6 +1030,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -1202,6 +1232,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1219,6 +1252,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -1333,6 +1369,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1350,6 +1389,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html index 3a77044afae..fab796a6685 100644 --- a/docs/dyn/compute_alpha.forwardingRules.html +++ b/docs/dyn/compute_alpha.forwardingRules.html @@ -141,6 +141,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -332,6 +333,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -400,6 +402,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -540,6 +543,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -638,6 +642,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. diff --git a/docs/dyn/compute_alpha.globalForwardingRules.html b/docs/dyn/compute_alpha.globalForwardingRules.html index f75e8696ef4..7ac29f08ac4 100644 --- a/docs/dyn/compute_alpha.globalForwardingRules.html +++ b/docs/dyn/compute_alpha.globalForwardingRules.html @@ -197,6 +197,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -264,6 +265,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -403,6 +405,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -500,6 +503,7 @@

Method Details

"IPProtocol": "A String", # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). "allPorts": True or False, # This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService. "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + "allowPscGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. "backendService": "A String", # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. diff --git a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html index ef6427b5b11..66c71ff0e3b 100644 --- a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html @@ -108,7 +108,7 @@

Method Details

Args: project: string, Project ID for this request. (required) publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -247,7 +247,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -423,7 +423,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index 27661d45882..31958260d8c 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -163,10 +163,10 @@

Instance Methods

Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request.

stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

-

Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is stopped, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_STOP on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not stopped. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.

+

Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.

suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

-

Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.

+

Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.

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

Returns permissions that a caller has on the specified resource.

@@ -2729,7 +2729,7 @@

Method Details

stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None) -
Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is stopped, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_STOP on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not stopped. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.
+  
Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -2807,7 +2807,7 @@ 

Method Details

suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None) -
Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.
+  
Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html
index 71ab4863314..cee60dc4301 100644
--- a/docs/dyn/compute_alpha.instanceTemplates.html
+++ b/docs/dyn/compute_alpha.instanceTemplates.html
@@ -266,6 +266,7 @@ 

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -343,8 +344,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -363,11 +364,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -380,7 +381,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -412,7 +413,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -678,6 +682,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -755,8 +760,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -775,11 +780,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -792,7 +797,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -824,7 +829,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1059,6 +1067,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -1136,8 +1145,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1156,11 +1165,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1173,7 +1182,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1205,7 +1214,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 8fa6aea5573..6bfc9bc52dd 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -250,8 +250,8 @@

Method Details

The object takes the form of: { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -499,6 +499,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -593,8 +594,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -613,11 +614,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -630,7 +631,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -653,6 +654,11 @@

Method Details

"externalIpEgressBandwidthTier": "A String", "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. @@ -877,6 +883,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -1072,6 +1079,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -1166,8 +1174,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1186,11 +1194,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1203,7 +1211,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1226,6 +1234,11 @@

Method Details

"externalIpEgressBandwidthTier": "A String", "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. @@ -1407,6 +1420,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -1484,8 +1498,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1504,11 +1518,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1521,7 +1535,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1553,7 +1567,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1994,6 +2011,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -2088,8 +2106,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2108,11 +2126,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2125,7 +2143,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -2148,6 +2166,11 @@

Method Details

"externalIpEgressBandwidthTier": "A String", "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. @@ -2300,6 +2323,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -2317,6 +2343,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -2829,6 +2858,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -2923,8 +2953,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2943,11 +2973,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2960,7 +2990,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -2983,6 +3013,11 @@

Method Details

"externalIpEgressBandwidthTier": "A String", "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. @@ -3253,6 +3288,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -3347,8 +3383,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -3367,11 +3403,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -3384,7 +3420,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -3407,6 +3443,11 @@

Method Details

"externalIpEgressBandwidthTier": "A String", "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. @@ -5636,6 +5677,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -5730,8 +5772,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -5750,11 +5792,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -5767,7 +5809,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -5790,6 +5832,11 @@

Method Details

"externalIpEgressBandwidthTier": "A String", "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. @@ -5987,8 +6034,8 @@

Method Details

The object takes the form of: { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -6150,8 +6197,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -6170,11 +6217,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -6187,7 +6234,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default diff --git a/docs/dyn/compute_alpha.instantSnapshots.html b/docs/dyn/compute_alpha.instantSnapshots.html index 7346d28c8b4..15e7ce4bfcb 100644 --- a/docs/dyn/compute_alpha.instantSnapshots.html +++ b/docs/dyn/compute_alpha.instantSnapshots.html @@ -153,6 +153,9 @@

Method Details

}, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "region": "A String", # [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "resourceStatus": { # [Output Only] Status information for the instant snapshot resource. + "storageSizeBytes": "A String", # [Output Only] The storage size of this instant snapshot. + }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. @@ -397,6 +400,9 @@

Method Details

}, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "region": "A String", # [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "resourceStatus": { # [Output Only] Status information for the instant snapshot resource. + "storageSizeBytes": "A String", # [Output Only] The storage size of this instant snapshot. + }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. @@ -535,6 +541,9 @@

Method Details

}, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "region": "A String", # [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "resourceStatus": { # [Output Only] Status information for the instant snapshot resource. + "storageSizeBytes": "A String", # [Output Only] The storage size of this instant snapshot. + }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. @@ -641,6 +650,9 @@

Method Details

}, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "region": "A String", # [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "resourceStatus": { # [Output Only] Status information for the instant snapshot resource. + "storageSizeBytes": "A String", # [Output Only] The storage size of this instant snapshot. + }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index 42c7f6e17bd..b040ee03d66 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -265,6 +265,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -342,8 +343,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -362,11 +363,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -379,7 +380,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -411,7 +412,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -567,8 +571,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -587,11 +591,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -604,7 +608,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -865,6 +869,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -942,8 +947,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -962,11 +967,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -979,7 +984,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1011,7 +1016,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1167,8 +1175,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1187,11 +1195,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1204,7 +1212,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1435,6 +1443,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -1512,8 +1521,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1532,11 +1541,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1549,7 +1558,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1581,7 +1590,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1737,8 +1749,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1757,11 +1769,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1774,7 +1786,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html index ca2a7b81a3e..991c839a6a2 100644 --- a/docs/dyn/compute_alpha.networkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html @@ -235,6 +235,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -252,6 +255,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -530,6 +536,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -547,6 +556,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -737,6 +749,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -754,6 +769,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -825,6 +843,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -842,6 +863,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -990,6 +1014,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1007,6 +1034,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -1112,6 +1142,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1129,6 +1162,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -1244,6 +1280,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1261,6 +1300,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html index 518626b137c..b02b8bec74e 100644 --- a/docs/dyn/compute_alpha.networks.html +++ b/docs/dyn/compute_alpha.networks.html @@ -390,6 +390,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -407,6 +410,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. diff --git a/docs/dyn/compute_alpha.nodeGroups.html b/docs/dyn/compute_alpha.nodeGroups.html index 365ac7d1c31..c423f93e1ce 100644 --- a/docs/dyn/compute_alpha.nodeGroups.html +++ b/docs/dyn/compute_alpha.nodeGroups.html @@ -881,7 +881,7 @@

Method Details

"diskType": "A String", # Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL. }, ], - "instanceConsumptionDatas": [ # Instance data that shows consumed resources on the node. + "instanceConsumptionData": [ # Instance data that shows consumed resources on the node. { "consumptionInfo": { # Resources consumed by the instance. "guestCpus": 42, # The number of virtual CPUs that are available to the instance. diff --git a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html index ae8ff63db4c..030ac649472 100644 --- a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html @@ -108,7 +108,7 @@

Method Details

Args: project: string, Project ID for this request. (required) publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -241,7 +241,7 @@

Method Details

"status": "A String", # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -411,7 +411,7 @@

Method Details

"status": "A String", # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html index ec22467478c..b2144330b74 100644 --- a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html @@ -212,7 +212,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region of this request. (required) publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -353,7 +353,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -531,7 +531,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index fa3f83e576a..b94a7f3c072 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -82,7 +82,7 @@

Instance Methods

Close httplib2 connections.

createSnapshot(project, region, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)

-

Creates a snapshot of this regional disk.

+

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

delete(project, region, disk, requestId=None, x__xgafv=None)

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

@@ -204,7 +204,7 @@

Method Details

createSnapshot(project, region, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None) -
Creates a snapshot of this regional disk.
+  
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -251,6 +251,7 @@ 

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index ed1ef06722d..e487844b869 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -157,10 +157,10 @@

Instance Methods

Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request.

stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

-

Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is stopped, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_STOP on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not stopped. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.

+

Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.

suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

-

Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.

+

Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.

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

Returns permissions that a caller has on the specified resource.

@@ -2501,7 +2501,7 @@

Method Details

stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) -
Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is stopped, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_STOP on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not stopped. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.
+  
Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -2579,7 +2579,7 @@ 

Method Details

suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) -
Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.
+  
Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html
index 152684e028a..bcb0297593d 100644
--- a/docs/dyn/compute_alpha.regionInstances.html
+++ b/docs/dyn/compute_alpha.regionInstances.html
@@ -167,6 +167,7 @@ 

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -261,8 +262,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -281,11 +282,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -298,7 +299,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -321,6 +322,11 @@

Method Details

"externalIpEgressBandwidthTier": "A String", "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. @@ -502,6 +508,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -579,8 +586,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -599,11 +606,11 @@

Method Details

}, ], "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. - "internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range. + "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -616,7 +623,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -648,7 +655,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. diff --git a/docs/dyn/compute_alpha.regionInstantSnapshots.html b/docs/dyn/compute_alpha.regionInstantSnapshots.html index 56d94194e00..380474ad214 100644 --- a/docs/dyn/compute_alpha.regionInstantSnapshots.html +++ b/docs/dyn/compute_alpha.regionInstantSnapshots.html @@ -298,6 +298,9 @@

Method Details

}, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "region": "A String", # [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "resourceStatus": { # [Output Only] Status information for the instant snapshot resource. + "storageSizeBytes": "A String", # [Output Only] The storage size of this instant snapshot. + }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. @@ -436,6 +439,9 @@

Method Details

}, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "region": "A String", # [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "resourceStatus": { # [Output Only] Status information for the instant snapshot resource. + "storageSizeBytes": "A String", # [Output Only] The storage size of this instant snapshot. + }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. @@ -542,6 +548,9 @@

Method Details

}, "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "region": "A String", # [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "resourceStatus": { # [Output Only] Status information for the instant snapshot resource. + "storageSizeBytes": "A String", # [Output Only] The storage size of this instant snapshot. + }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html index cc95668bae8..6c411fc46a0 100644 --- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html @@ -240,6 +240,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -257,6 +260,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -538,6 +544,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -555,6 +564,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -649,6 +661,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -666,6 +681,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -887,6 +905,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -904,6 +925,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -976,6 +1000,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -993,6 +1020,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -1142,6 +1172,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1159,6 +1192,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -1265,6 +1301,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1282,6 +1321,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. @@ -1398,6 +1440,9 @@

Method Details

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. "A String", ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. { "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. @@ -1415,6 +1460,9 @@

Method Details

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. "A String", ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. { "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. diff --git a/docs/dyn/compute_alpha.regionNotificationEndpoints.html b/docs/dyn/compute_alpha.regionNotificationEndpoints.html index 3be6d789752..5cfa491552e 100644 --- a/docs/dyn/compute_alpha.regionNotificationEndpoints.html +++ b/docs/dyn/compute_alpha.regionNotificationEndpoints.html @@ -205,7 +205,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) notificationEndpoint: string, Name of the NotificationEndpoint resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -332,7 +332,7 @@

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.regionSslCertificates.html b/docs/dyn/compute_alpha.regionSslCertificates.html index c19c56bed7c..8fc59a7ddfd 100644 --- a/docs/dyn/compute_alpha.regionSslCertificates.html +++ b/docs/dyn/compute_alpha.regionSslCertificates.html @@ -109,7 +109,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) sslCertificate: string, Name of the SslCertificate resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -258,7 +258,7 @@

Method Details

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html index 8242c47004c..db463a9d8fb 100644 --- a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html @@ -115,7 +115,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -256,7 +256,7 @@

Method Details

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -413,7 +413,7 @@

Method Details

], } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -488,7 +488,7 @@

Method Details

"urlMap": "A String", } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.serviceAttachments.html b/docs/dyn/compute_alpha.serviceAttachments.html index 6ee7cbaf60d..695a48aab80 100644 --- a/docs/dyn/compute_alpha.serviceAttachments.html +++ b/docs/dyn/compute_alpha.serviceAttachments.html @@ -156,7 +156,7 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. - "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com". + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. "A String", ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. @@ -235,7 +235,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region of this request. (required) serviceAttachment: string, Name of the ServiceAttachment resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -331,7 +331,7 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. - "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com". + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. "A String", ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. @@ -487,7 +487,7 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. - "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com". + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. "A String", ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. @@ -508,7 +508,7 @@

Method Details

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -611,7 +611,7 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. - "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com". + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. "A String", ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. @@ -693,7 +693,7 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. - "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com". + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. "A String", ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. @@ -714,7 +714,7 @@

Method Details

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html index ee3037ed319..dc96bb1b5bd 100644 --- a/docs/dyn/compute_alpha.snapshots.html +++ b/docs/dyn/compute_alpha.snapshots.html @@ -88,7 +88,7 @@

Instance Methods

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body=None, requestId=None, x__xgafv=None)

-

Creates a snapshot in the specified project using the data included in the request.

+

Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of Snapshot resources contained within the specified project.

@@ -230,6 +230,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -358,7 +359,7 @@

Method Details

insert(project, body=None, requestId=None, x__xgafv=None) -
Creates a snapshot in the specified project using the data included in the request.
+  
Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -403,6 +404,7 @@ 

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key @@ -545,6 +547,7 @@

Method Details

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. }, + "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key diff --git a/docs/dyn/compute_alpha.sslCertificates.html b/docs/dyn/compute_alpha.sslCertificates.html index 09e85987b04..ca497616f43 100644 --- a/docs/dyn/compute_alpha.sslCertificates.html +++ b/docs/dyn/compute_alpha.sslCertificates.html @@ -215,7 +215,7 @@

Method Details

Args: project: string, Project ID for this request. (required) sslCertificate: string, Name of the SslCertificate resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -362,7 +362,7 @@

Method Details

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html index c6cc17e36dc..44082f4fd28 100644 --- a/docs/dyn/compute_alpha.subnetworks.html +++ b/docs/dyn/compute_alpha.subnetworks.html @@ -163,7 +163,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -427,7 +427,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -597,7 +597,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -735,7 +735,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -896,7 +896,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. diff --git a/docs/dyn/compute_alpha.targetGrpcProxies.html b/docs/dyn/compute_alpha.targetGrpcProxies.html index 1059ccd027c..f31e1404396 100644 --- a/docs/dyn/compute_alpha.targetGrpcProxies.html +++ b/docs/dyn/compute_alpha.targetGrpcProxies.html @@ -111,7 +111,7 @@

Method Details

Args: project: string, Project ID for this request. (required) targetGrpcProxy: string, Name of the TargetGrpcProxy resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -222,7 +222,7 @@

Method Details

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -370,7 +370,7 @@

Method Details

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.targetHttpProxies.html b/docs/dyn/compute_alpha.targetHttpProxies.html index 8a30f6e8791..af3607d95a9 100644 --- a/docs/dyn/compute_alpha.targetHttpProxies.html +++ b/docs/dyn/compute_alpha.targetHttpProxies.html @@ -482,7 +482,7 @@

Method Details

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.targetHttpsProxies.html b/docs/dyn/compute_alpha.targetHttpsProxies.html index b6c27cf5fe2..ebf7742e1fa 100644 --- a/docs/dyn/compute_alpha.targetHttpsProxies.html +++ b/docs/dyn/compute_alpha.targetHttpsProxies.html @@ -544,7 +544,7 @@

Method Details

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html index 089e5167b84..fb1578cf393 100644 --- a/docs/dyn/compute_beta.disks.html +++ b/docs/dyn/compute_beta.disks.html @@ -88,7 +88,7 @@

Instance Methods

Close httplib2 connections.

createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)

-

Creates a snapshot of a specified persistent disk.

+

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

delete(project, zone, disk, requestId=None, x__xgafv=None)

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

@@ -124,7 +124,7 @@

Instance Methods

Returns permissions that a caller has on the specified resource.

update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

-

Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

+

Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

Method Details

addResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None) @@ -357,7 +357,7 @@

Method Details

createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None) -
Creates a snapshot of a specified persistent disk.
+  
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -1484,7 +1484,7 @@ 

Method Details

update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None) -
Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.
+  
Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html
index 5b980beda1b..320fecd68da 100644
--- a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html
+++ b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html
@@ -108,7 +108,7 @@ 

Method Details

Args: project: string, Project ID for this request. (required) publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -241,7 +241,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -411,7 +411,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index d8237320388..772716394c4 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -233,6 +233,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -322,8 +325,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -342,8 +345,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -354,7 +357,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -377,7 +380,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -601,6 +607,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -690,8 +699,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -710,8 +719,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -722,7 +731,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -745,7 +754,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -934,6 +946,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -1023,8 +1038,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1043,8 +1058,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1055,7 +1070,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1078,7 +1093,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 884a3ea2383..4d52bf34bdb 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -247,8 +247,8 @@

Method Details

The object takes the form of: { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -457,6 +457,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -556,8 +559,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -576,8 +579,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -588,7 +591,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -602,6 +605,11 @@

Method Details

"networkPerformanceConfig": { "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -768,6 +776,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -940,6 +951,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -1029,8 +1043,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1049,8 +1063,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1061,7 +1075,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1084,7 +1098,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1468,6 +1485,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -1567,8 +1587,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1587,8 +1607,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1599,7 +1619,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1613,6 +1633,11 @@

Method Details

"networkPerformanceConfig": { "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -2191,6 +2216,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -2290,8 +2318,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2310,8 +2338,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2322,7 +2350,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -2336,6 +2364,11 @@

Method Details

"networkPerformanceConfig": { "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -2541,6 +2574,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -2640,8 +2676,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2660,8 +2696,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2672,7 +2708,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -2686,6 +2722,11 @@

Method Details

"networkPerformanceConfig": { "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -4685,6 +4726,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -4784,8 +4828,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -4804,8 +4848,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -4816,7 +4860,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -4830,6 +4874,11 @@

Method Details

"networkPerformanceConfig": { "totalEgressBandwidthTier": "A String", }, + "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + }, "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -4990,8 +5039,8 @@

Method Details

The object takes the form of: { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -5143,8 +5192,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -5163,8 +5212,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -5175,7 +5224,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default diff --git a/docs/dyn/compute_beta.interconnectAttachments.html b/docs/dyn/compute_beta.interconnectAttachments.html index 07ea9989942..0ece2caf978 100644 --- a/docs/dyn/compute_beta.interconnectAttachments.html +++ b/docs/dyn/compute_beta.interconnectAttachments.html @@ -136,12 +136,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -174,6 +181,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -312,12 +320,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -350,6 +365,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -369,12 +385,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -407,6 +430,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -495,12 +519,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -533,6 +564,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -582,12 +614,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -620,6 +659,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index 5e6e35b0eb9..5ee9bdcb39b 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -232,6 +232,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -321,8 +324,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -341,8 +344,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -353,7 +356,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -376,7 +379,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -518,8 +524,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -538,8 +544,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -550,7 +556,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -765,6 +771,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -854,8 +863,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -874,8 +883,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -886,7 +895,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -909,7 +918,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1051,8 +1063,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1071,8 +1083,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1083,7 +1095,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1264,6 +1276,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -1353,8 +1368,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1373,8 +1388,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1385,7 +1400,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1408,7 +1423,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1550,8 +1568,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1570,8 +1588,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1582,7 +1600,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default diff --git a/docs/dyn/compute_beta.publicAdvertisedPrefixes.html b/docs/dyn/compute_beta.publicAdvertisedPrefixes.html index 4ee47c3384b..1e021108f08 100644 --- a/docs/dyn/compute_beta.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_beta.publicAdvertisedPrefixes.html @@ -108,7 +108,7 @@

Method Details

Args: project: string, Project ID for this request. (required) publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -235,7 +235,7 @@

Method Details

"status": "A String", # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -399,7 +399,7 @@

Method Details

"status": "A String", # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.publicDelegatedPrefixes.html b/docs/dyn/compute_beta.publicDelegatedPrefixes.html index 142ab93d66d..9dd3e981900 100644 --- a/docs/dyn/compute_beta.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_beta.publicDelegatedPrefixes.html @@ -211,7 +211,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region of this request. (required) publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -346,7 +346,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -518,7 +518,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html index 3d747f24777..26c94aa8ff7 100644 --- a/docs/dyn/compute_beta.regionDisks.html +++ b/docs/dyn/compute_beta.regionDisks.html @@ -82,7 +82,7 @@

Instance Methods

Close httplib2 connections.

createSnapshot(project, region, disk, body=None, requestId=None, x__xgafv=None)

-

Creates a snapshot of this regional disk.

+

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

delete(project, region, disk, requestId=None, x__xgafv=None)

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

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

Method Details

createSnapshot(project, region, disk, body=None, requestId=None, x__xgafv=None) -
Creates a snapshot of this regional disk.
+  
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html
index 36a49f9c8e3..654492ea5d8 100644
--- a/docs/dyn/compute_beta.regionInstances.html
+++ b/docs/dyn/compute_beta.regionInstances.html
@@ -135,6 +135,9 @@ 

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. @@ -224,8 +227,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -244,8 +247,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -256,7 +259,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -279,7 +282,10 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. diff --git a/docs/dyn/compute_beta.regionNotificationEndpoints.html b/docs/dyn/compute_beta.regionNotificationEndpoints.html index fcf084469db..8aba604385b 100644 --- a/docs/dyn/compute_beta.regionNotificationEndpoints.html +++ b/docs/dyn/compute_beta.regionNotificationEndpoints.html @@ -109,7 +109,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) notificationEndpoint: string, Name of the NotificationEndpoint resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -232,7 +232,7 @@

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.regionSslCertificates.html b/docs/dyn/compute_beta.regionSslCertificates.html index b2c781c930f..1424480f303 100644 --- a/docs/dyn/compute_beta.regionSslCertificates.html +++ b/docs/dyn/compute_beta.regionSslCertificates.html @@ -109,7 +109,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) sslCertificate: string, Name of the SslCertificate resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -252,7 +252,7 @@

Method Details

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.regionTargetHttpsProxies.html b/docs/dyn/compute_beta.regionTargetHttpsProxies.html index c0569e5fdeb..ed5e0b66efd 100644 --- a/docs/dyn/compute_beta.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_beta.regionTargetHttpsProxies.html @@ -115,7 +115,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -250,7 +250,7 @@

Method Details

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -402,7 +402,7 @@

Method Details

], } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -473,7 +473,7 @@

Method Details

"urlMap": "A String", } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.serviceAttachments.html b/docs/dyn/compute_beta.serviceAttachments.html index 95666c16a7f..a4edb66102f 100644 --- a/docs/dyn/compute_beta.serviceAttachments.html +++ b/docs/dyn/compute_beta.serviceAttachments.html @@ -156,6 +156,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -232,7 +235,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region of this request. (required) serviceAttachment: string, Name of the ServiceAttachment resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -324,6 +327,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -477,6 +483,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -495,7 +504,7 @@

Method Details

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -594,6 +603,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -673,6 +685,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -691,7 +706,7 @@

Method Details

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html index c6d7e64db6d..e63ea3142d0 100644 --- a/docs/dyn/compute_beta.snapshots.html +++ b/docs/dyn/compute_beta.snapshots.html @@ -88,7 +88,7 @@

Instance Methods

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body=None, requestId=None, x__xgafv=None)

-

Creates a snapshot in the specified project using the data included in the request.

+

Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of Snapshot resources contained within the specified project.

@@ -345,7 +345,7 @@

Method Details

insert(project, body=None, requestId=None, x__xgafv=None) -
Creates a snapshot in the specified project using the data included in the request.
+  
Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.sslCertificates.html b/docs/dyn/compute_beta.sslCertificates.html
index 15540412305..4844827bfd7 100644
--- a/docs/dyn/compute_beta.sslCertificates.html
+++ b/docs/dyn/compute_beta.sslCertificates.html
@@ -214,7 +214,7 @@ 

Method Details

Args: project: string, Project ID for this request. (required) sslCertificate: string, Name of the SslCertificate resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -355,7 +355,7 @@

Method Details

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html index b5d177204a7..27aeafb9394 100644 --- a/docs/dyn/compute_beta.subnetworks.html +++ b/docs/dyn/compute_beta.subnetworks.html @@ -159,7 +159,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -401,7 +401,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -557,7 +557,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -677,7 +677,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -824,7 +824,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. diff --git a/docs/dyn/compute_beta.targetGrpcProxies.html b/docs/dyn/compute_beta.targetGrpcProxies.html index c85f353b9bd..38d72a1df7a 100644 --- a/docs/dyn/compute_beta.targetGrpcProxies.html +++ b/docs/dyn/compute_beta.targetGrpcProxies.html @@ -111,7 +111,7 @@

Method Details

Args: project: string, Project ID for this request. (required) targetGrpcProxy: string, Name of the TargetGrpcProxy resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -218,7 +218,7 @@

Method Details

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -362,7 +362,7 @@

Method Details

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.targetHttpProxies.html b/docs/dyn/compute_beta.targetHttpProxies.html index 15f79bd0f45..4f02bb7dbff 100644 --- a/docs/dyn/compute_beta.targetHttpProxies.html +++ b/docs/dyn/compute_beta.targetHttpProxies.html @@ -469,7 +469,7 @@

Method Details

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.targetHttpsProxies.html b/docs/dyn/compute_beta.targetHttpsProxies.html index 6ba3ed66950..047a4d9d2a5 100644 --- a/docs/dyn/compute_beta.targetHttpsProxies.html +++ b/docs/dyn/compute_beta.targetHttpsProxies.html @@ -531,7 +531,7 @@

Method Details

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html index 248ea78804f..ecc6d9e964d 100644 --- a/docs/dyn/compute_v1.disks.html +++ b/docs/dyn/compute_v1.disks.html @@ -88,7 +88,7 @@

Instance Methods

Close httplib2 connections.

createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)

-

Creates a snapshot of a specified persistent disk.

+

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

delete(project, zone, disk, requestId=None, x__xgafv=None)

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

@@ -346,7 +346,7 @@

Method Details

createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None) -
Creates a snapshot of a specified persistent disk.
+  
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html
index 900202705f8..4c518f4b001 100644
--- a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html
+++ b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html
@@ -374,6 +374,7 @@ 

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -417,6 +418,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -528,6 +530,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. diff --git a/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html index 1a07733734e..a9e3cee7d0e 100644 --- a/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html @@ -108,7 +108,7 @@

Method Details

Args: project: string, Project ID for this request. (required) publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -241,7 +241,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -411,7 +411,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index 63f2bf284b1..3db451f5656 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -228,6 +228,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -309,8 +312,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -329,8 +332,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -341,7 +344,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -363,7 +366,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -574,6 +577,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -655,8 +661,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -675,8 +681,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -687,7 +693,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -709,7 +715,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -885,6 +891,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -966,8 +975,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -986,8 +995,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -998,7 +1007,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1020,7 +1029,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 53ad6b22880..3fe18151ad4 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -229,8 +229,8 @@

Method Details

The object takes the form of: { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -434,6 +434,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -527,8 +530,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -547,8 +550,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -559,7 +562,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -722,6 +725,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -884,6 +890,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -965,8 +974,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -985,8 +994,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -997,7 +1006,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1019,7 +1028,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1389,6 +1398,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -1482,8 +1494,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1502,8 +1514,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1514,7 +1526,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1979,6 +1991,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -2072,8 +2087,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2092,8 +2107,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2104,7 +2119,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -2306,6 +2321,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -2399,8 +2417,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2419,8 +2437,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -2431,7 +2449,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -4127,6 +4145,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -4220,8 +4241,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -4240,8 +4261,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -4252,7 +4273,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -4414,8 +4435,8 @@

Method Details

The object takes the form of: { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -4567,8 +4588,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -4587,8 +4608,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -4599,7 +4620,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default diff --git a/docs/dyn/compute_v1.interconnectAttachments.html b/docs/dyn/compute_v1.interconnectAttachments.html index ce87d1823e0..839164e8be4 100644 --- a/docs/dyn/compute_v1.interconnectAttachments.html +++ b/docs/dyn/compute_v1.interconnectAttachments.html @@ -130,12 +130,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -164,6 +171,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -302,12 +310,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -336,6 +351,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -355,12 +371,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -389,6 +412,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -477,12 +501,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -511,6 +542,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -560,12 +592,19 @@

Method Details

{ # Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s + "candidateIpv6Subnets": [ # Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected. + "A String", + ], "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. "A String", ], "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. + "cloudRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6Address": "A String", # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. + "customerRouterIpv6InterfaceId": "A String", # If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet. "dataplaneVersion": 42, # [Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. "description": "A String", # An optional description of this resource. "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. @@ -594,6 +633,7 @@

Method Details

"router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "stackType": "A String", # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. "type": "A String", # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index 9983c7cc79c..c9d604fd194 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -227,6 +227,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -308,8 +311,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -328,8 +331,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -340,7 +343,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -362,7 +365,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -496,8 +499,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -516,8 +519,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -528,7 +531,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -734,6 +737,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -815,8 +821,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -835,8 +841,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -847,7 +853,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -869,7 +875,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1003,8 +1009,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1023,8 +1029,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1035,7 +1041,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1207,6 +1213,9 @@

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -1288,8 +1297,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1308,8 +1317,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1320,7 +1329,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -1342,7 +1351,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. @@ -1476,8 +1485,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1496,8 +1505,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -1508,7 +1517,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default diff --git a/docs/dyn/compute_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html index 6b67a1403b4..5942abee824 100644 --- a/docs/dyn/compute_v1.networkEndpointGroups.html +++ b/docs/dyn/compute_v1.networkEndpointGroups.html @@ -165,6 +165,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -490,6 +491,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -534,6 +536,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -646,6 +649,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. diff --git a/docs/dyn/compute_v1.publicAdvertisedPrefixes.html b/docs/dyn/compute_v1.publicAdvertisedPrefixes.html index e05226cdb94..45952629428 100644 --- a/docs/dyn/compute_v1.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_v1.publicAdvertisedPrefixes.html @@ -108,7 +108,7 @@

Method Details

Args: project: string, Project ID for this request. (required) publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -235,7 +235,7 @@

Method Details

"status": "A String", # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -399,7 +399,7 @@

Method Details

"status": "A String", # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.publicDelegatedPrefixes.html b/docs/dyn/compute_v1.publicDelegatedPrefixes.html index 168e65b85dd..e4bc5c2dc9c 100644 --- a/docs/dyn/compute_v1.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_v1.publicDelegatedPrefixes.html @@ -211,7 +211,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region of this request. (required) publicDelegatedPrefix: string, Name of the PublicDelegatedPrefix resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -346,7 +346,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -518,7 +518,7 @@

Method Details

"status": "A String", # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html index dc3df04131c..9ed7cb00f67 100644 --- a/docs/dyn/compute_v1.regionDisks.html +++ b/docs/dyn/compute_v1.regionDisks.html @@ -82,7 +82,7 @@

Instance Methods

Close httplib2 connections.

createSnapshot(project, region, disk, body=None, requestId=None, x__xgafv=None)

-

Creates a snapshot of this regional disk.

+

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

delete(project, region, disk, requestId=None, x__xgafv=None)

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

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

Method Details

createSnapshot(project, region, disk, body=None, requestId=None, x__xgafv=None) -
Creates a snapshot of this regional disk.
+  
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html
index ecc3d39d366..46fd26b62d9 100644
--- a/docs/dyn/compute_v1.regionInstances.html
+++ b/docs/dyn/compute_v1.regionInstances.html
@@ -130,6 +130,9 @@ 

Method Details

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. "a_key": "A String", }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. @@ -211,8 +214,8 @@

Method Details

{ # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -231,8 +234,8 @@

Method Details

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. - "externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. - "externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range. + "externalIpv6": "A String", # The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically. + "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. @@ -243,7 +246,7 @@

Method Details

}, ], "ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. + "ipv6Address": "A String", # An IPv6 internal network address for this network interface. "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. "network": "A String", # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default @@ -265,7 +268,7 @@

Method Details

"A String", ], }, - "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. + "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. diff --git a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html index 8824935e2db..0ddbb3d1b0d 100644 --- a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html @@ -204,6 +204,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -248,6 +249,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -360,6 +362,7 @@

Method Details

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. diff --git a/docs/dyn/compute_v1.regionNotificationEndpoints.html b/docs/dyn/compute_v1.regionNotificationEndpoints.html index 764ed585110..234c523a061 100644 --- a/docs/dyn/compute_v1.regionNotificationEndpoints.html +++ b/docs/dyn/compute_v1.regionNotificationEndpoints.html @@ -106,7 +106,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) notificationEndpoint: string, Name of the NotificationEndpoint resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -229,7 +229,7 @@

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.regionSslCertificates.html b/docs/dyn/compute_v1.regionSslCertificates.html index 9ce6b04402a..4ad1e046c8f 100644 --- a/docs/dyn/compute_v1.regionSslCertificates.html +++ b/docs/dyn/compute_v1.regionSslCertificates.html @@ -106,7 +106,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) sslCertificate: string, Name of the SslCertificate resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -249,7 +249,7 @@

Method Details

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.regionTargetHttpsProxies.html b/docs/dyn/compute_v1.regionTargetHttpsProxies.html index 183a979be2a..92803251df9 100644 --- a/docs/dyn/compute_v1.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_v1.regionTargetHttpsProxies.html @@ -112,7 +112,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -235,7 +235,7 @@

Method Details

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -381,7 +381,7 @@

Method Details

], } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -452,7 +452,7 @@

Method Details

"urlMap": "A String", } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.serviceAttachments.html b/docs/dyn/compute_v1.serviceAttachments.html index e9a059aeeb1..2b0b00dcc44 100644 --- a/docs/dyn/compute_v1.serviceAttachments.html +++ b/docs/dyn/compute_v1.serviceAttachments.html @@ -156,6 +156,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -232,7 +235,7 @@

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region of this request. (required) serviceAttachment: string, Name of the ServiceAttachment resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -324,6 +327,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -477,6 +483,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -495,7 +504,7 @@

Method Details

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -594,6 +603,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -673,6 +685,9 @@

Method Details

], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "domainNames": [ # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. + "A String", + ], "enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. @@ -691,7 +706,7 @@

Method Details

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index 24d430d1286..fa2b0bc39e9 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -88,7 +88,7 @@

Instance Methods

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

insert(project, body=None, requestId=None, x__xgafv=None)

-

Creates a snapshot in the specified project using the data included in the request.

+

Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of Snapshot resources contained within the specified project.

@@ -341,7 +341,7 @@

Method Details

insert(project, body=None, requestId=None, x__xgafv=None) -
Creates a snapshot in the specified project using the data included in the request.
+  
Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.sslCertificates.html b/docs/dyn/compute_v1.sslCertificates.html
index e558fdc2f84..8dbaa3470d4 100644
--- a/docs/dyn/compute_v1.sslCertificates.html
+++ b/docs/dyn/compute_v1.sslCertificates.html
@@ -211,7 +211,7 @@ 

Method Details

Args: project: string, Project ID for this request. (required) sslCertificate: string, Name of the SslCertificate resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -352,7 +352,7 @@

Method Details

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html index e23c6606492..a51e202456f 100644 --- a/docs/dyn/compute_v1.subnetworks.html +++ b/docs/dyn/compute_v1.subnetworks.html @@ -158,7 +158,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -399,7 +399,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -554,7 +554,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -673,7 +673,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. @@ -818,7 +818,7 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. "ipv6AccessType": "A String", # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6_type is EXTERNAL then this subnet cannot enable direct path. - "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + "ipv6CidrRange": "A String", # [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually. "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. "aggregationInterval": "A String", # Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. diff --git a/docs/dyn/compute_v1.targetGrpcProxies.html b/docs/dyn/compute_v1.targetGrpcProxies.html index 511e7efe2a9..721f52ab80e 100644 --- a/docs/dyn/compute_v1.targetGrpcProxies.html +++ b/docs/dyn/compute_v1.targetGrpcProxies.html @@ -108,7 +108,7 @@

Method Details

Args: project: string, Project ID for this request. (required) targetGrpcProxy: string, Name of the TargetGrpcProxy resource to delete. (required) - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,7 +215,7 @@

Method Details

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -359,7 +359,7 @@

Method Details

"validateForProxyless": True or False, # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.targetHttpProxies.html b/docs/dyn/compute_v1.targetHttpProxies.html index 67343e910e4..4290a168304 100644 --- a/docs/dyn/compute_v1.targetHttpProxies.html +++ b/docs/dyn/compute_v1.targetHttpProxies.html @@ -441,7 +441,7 @@

Method Details

"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_v1.targetHttpsProxies.html b/docs/dyn/compute_v1.targetHttpsProxies.html index c433f225559..5c5280ad5fa 100644 --- a/docs/dyn/compute_v1.targetHttpsProxies.html +++ b/docs/dyn/compute_v1.targetHttpsProxies.html @@ -495,7 +495,7 @@

Method Details

"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index e3398bb1575..77313b68d32 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -288,6 +288,7 @@

Method Details

}, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} + "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} @@ -518,6 +519,7 @@

Method Details

}, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} + "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} @@ -645,8 +647,8 @@

Method Details

view: string, The level of details of the conversation. Default is `FULL`. Allowed values CONVERSATION_VIEW_UNSPECIFIED - Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest. - BASIC - Transcript field is not populated in the response. - FULL - All fields are populated. + BASIC - Transcript field is not populated in the response for Insights conversation. + FULL - All fields are populated for Insights conversation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -778,6 +780,7 @@

Method Details

}, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} + "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} @@ -889,8 +892,8 @@

Method Details

view: string, The level of details of the conversation. Default is `BASIC`. Allowed values CONVERSATION_VIEW_UNSPECIFIED - Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest. - BASIC - Transcript field is not populated in the response. - FULL - All fields are populated. + BASIC - Transcript field is not populated in the response for Insights conversation. + FULL - All fields are populated for Insights conversation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1024,6 +1027,7 @@

Method Details

}, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} + "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} @@ -1272,6 +1276,7 @@

Method Details

}, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} + "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} @@ -1502,6 +1507,7 @@

Method Details

}, "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} + "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us. "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index fcf581bc153..15cdec624cf 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -390,6 +390,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -397,6 +400,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -448,6 +454,9 @@

Method Details

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster. "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4) + "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. @@ -478,7 +487,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -575,7 +584,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -663,6 +672,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1018,6 +1032,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1025,6 +1042,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1076,6 +1096,9 @@

Method Details

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster. "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4) + "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. @@ -1106,7 +1129,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1203,7 +1226,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1291,6 +1314,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1549,6 +1577,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1556,6 +1587,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1607,6 +1641,9 @@

Method Details

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster. "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4) + "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. @@ -1637,7 +1674,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1734,7 +1771,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1822,6 +1859,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -2239,6 +2281,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -2246,6 +2291,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -2881,6 +2929,11 @@

Method Details

"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -2908,6 +2961,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "desiredServiceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 4d46f8934f4..1539ba3a784 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -159,7 +159,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -436,7 +436,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -579,7 +579,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1015,7 +1015,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 891697bc221..240fa3d6634 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -494,6 +494,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -501,6 +504,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -552,6 +558,9 @@

Method Details

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster. "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4) + "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. @@ -582,7 +591,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -679,7 +688,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -767,6 +776,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1122,6 +1136,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1129,6 +1146,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1180,6 +1200,9 @@

Method Details

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster. "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4) + "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. @@ -1210,7 +1233,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1307,7 +1330,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1395,6 +1418,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1697,6 +1725,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1704,6 +1735,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1755,6 +1789,9 @@

Method Details

"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster. "network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "privateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4) + "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. @@ -1785,7 +1822,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1882,7 +1919,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1970,6 +2007,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -2451,6 +2493,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -2458,6 +2503,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -2942,6 +2990,11 @@

Method Details

"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -2969,6 +3022,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "desiredServiceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field. + "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. + }, "desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index f765ea082c2..78b9e0e9b8a 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -248,7 +248,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -525,7 +525,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -668,7 +668,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1032,7 +1032,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index a7abc5d4def..3e1417ba8e1 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -404,6 +404,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -411,6 +414,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -504,7 +510,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -607,7 +613,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -698,6 +704,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1081,6 +1092,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1088,6 +1102,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1181,7 +1198,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1284,7 +1301,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1375,6 +1392,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1661,6 +1683,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1668,6 +1693,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1761,7 +1789,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1864,7 +1892,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1955,6 +1983,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -2393,6 +2426,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -2400,6 +2436,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -2992,7 +3031,7 @@

Method Details

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records. "clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records. }, - "desiredGcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # The desired GCFS config for the cluster + "desiredGcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # The desired GCFS config for the cluster. "enabled": True or False, # Whether to use GCFS. }, "desiredIdentityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # The desired Identity Service component configuration. @@ -3053,6 +3092,11 @@

Method Details

"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 8ac5fb860d8..c5a9815f7d3 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -162,7 +162,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -445,7 +445,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -594,7 +594,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1033,7 +1033,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # Collection of node-level [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels). # The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be *replaced* with the provided labels. "labels": { # Map of node label keys and node label values. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index c52c73a65de..9992b652008 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -515,6 +515,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -522,6 +525,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -615,7 +621,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -718,7 +724,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -809,6 +815,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1192,6 +1203,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1199,6 +1213,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1292,7 +1309,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1395,7 +1412,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1486,6 +1503,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -1816,6 +1838,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1823,6 +1848,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -1916,7 +1944,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -2019,7 +2047,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -2110,6 +2138,11 @@

Method Details

"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, @@ -2605,6 +2638,9 @@

Method Details

"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. "a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -2612,6 +2648,9 @@

Method Details

"recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. "window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. + "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. + }, "startTime": "A String", # The time that the window first starts. }, }, @@ -3053,7 +3092,7 @@

Method Details

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records. "clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records. }, - "desiredGcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # The desired GCFS config for the cluster + "desiredGcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # The desired GCFS config for the cluster. "enabled": True or False, # Whether to use GCFS. }, "desiredIdentityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # The desired Identity Service component configuration. @@ -3114,6 +3153,11 @@

Method Details

"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration. "pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub. "enabled": True or False, # Enable notifications for Pub/Sub. + "filter": { # Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent # Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent + "eventType": [ # Event types to allowlist. + "A String", + ], + }, "topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`. }, }, diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 01153c88f30..3a412a8b505 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -251,7 +251,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -534,7 +534,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -683,7 +683,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ "a_key": "A String", @@ -1050,7 +1050,7 @@

Method Details

"kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration. - "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. + "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. }, "labels": { # Collection of node-level [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels). # The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be *replaced* with the provided labels. "labels": { # Map of node label keys and node label values. diff --git a/docs/dyn/containeranalysis_v1.html b/docs/dyn/containeranalysis_v1.html index b74ef19e4c0..14577ae8241 100644 --- a/docs/dyn/containeranalysis_v1.html +++ b/docs/dyn/containeranalysis_v1.html @@ -74,11 +74,6 @@

Container Analysis API

Instance Methods

-

- operations() -

-

Returns the operations Resource.

-

projects()

diff --git a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html index ae3f7e3266a..896c748758d 100644 --- a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html @@ -580,6 +580,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. diff --git a/docs/dyn/containeranalysis_v1.projects.occurrences.html b/docs/dyn/containeranalysis_v1.projects.occurrences.html index 91389ac86ef..37850fe941f 100644 --- a/docs/dyn/containeranalysis_v1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.occurrences.html @@ -596,6 +596,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. @@ -1121,6 +1135,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. @@ -1651,6 +1679,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. @@ -2172,6 +2214,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. @@ -2718,6 +2774,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. @@ -3534,6 +3604,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. @@ -4073,6 +4157,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. @@ -4595,6 +4693,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. diff --git a/docs/dyn/datacatalog_v1.catalog.html b/docs/dyn/datacatalog_v1.catalog.html index 303d74995cf..8b2f528c6a4 100644 --- a/docs/dyn/datacatalog_v1.catalog.html +++ b/docs/dyn/datacatalog_v1.catalog.html @@ -98,10 +98,10 @@

Method Details

The object takes the form of: { # Request message for SearchCatalog. - "orderBy": "A String", # Specifies the order of results. Currently supported case-sensitive values are: * `relevance` that can only be descending * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default If this parameter is omitted, it defaults to the descending `relevance`. + "orderBy": "A String", # Specifies the order of results. Currently supported case-sensitive values are: * `relevance` that can only be descending * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`. "pageSize": 42, # Number of results to return in a single search page. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception. "pageToken": "A String", # Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call. - "query": "A String", # Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see [Data Catalog search syntax](/data-catalog/docs/how-to/search-reference). An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: * `name:x` * `column:y` * `description:z` + "query": "A String", # Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference). An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: * `name:x` * `column:y` * `description:z` "scope": { # The criteria that select the subspace used for query matching. # Required. The scope of this search request. The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error. "includeGcpPublicDatasets": True or False, # If `true`, include Google Cloud Platform (GCP) public datasets in search results. By default, they are excluded. See [Google Cloud Public Datasets](/public-datasets) for more information. "includeOrgIds": [ # The list of organization IDs to search within. To find your organization ID, follow the steps from [Creating and managing organizations] (/resource-manager/docs/creating-managing-organization). @@ -110,10 +110,11 @@

Method Details

"includeProjectIds": [ # The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, see [Projects](/docs/overview/#projects). "A String", ], - "includePublicTagTemplates": True or False, # Optional. If `true`, include public tag templates in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner. Other scope fields, for example, ``include_org_ids``, still restrict the returned public tag templates and at least one of them is required. + "includePublicTagTemplates": True or False, # Optional. If `true`, include public tag templates in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner. Other scope fields, for example, `include_org_ids`, still restrict the returned public tag templates and at least one of them is required. "restrictedLocations": [ # Optional. The list of locations to search within. If empty, all locations are searched. Returns an error if any location in the list isn't one of the [Supported regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions). If a location is unreachable, its name is returned in the `SearchCatalogResponse.unreachable` field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter. "A String", ], + "starredOnly": True or False, # Optional. If `true`, search only among starred entries. By default, all results are returned, starred or not. }, } diff --git a/docs/dyn/datacatalog_v1.entries.html b/docs/dyn/datacatalog_v1.entries.html index ee45a3137e3..2fcc4ae2f16 100644 --- a/docs/dyn/datacatalog_v1.entries.html +++ b/docs/dyn/datacatalog_v1.entries.html @@ -161,6 +161,10 @@

Method Details

}, "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + "personalDetails": { # Entry metadata relevant only to the user and private to them. # Output only. Additional information related to the entry. Private to the current user. + "starTime": "A String", # Set if the entry is starred; unset otherwise. + "starred": True or False, # True if the entry is starred by the user; false otherwise. + }, "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. "importedLibraries": [ # Paths of the imported libraries. diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html index b617995f3ca..6d273cdb6ab 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html @@ -103,9 +103,15 @@

Instance Methods

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

Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

+

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

+

Marks an Entry as starred by the current user. Starring information is private to each user.

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

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.

+

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

+

Marks an Entry as NOT starred by the current user. Starring information is private to each user.

Method Details

close() @@ -180,6 +186,10 @@

Method Details

}, "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + "personalDetails": { # Entry metadata relevant only to the user and private to them. # Output only. Additional information related to the entry. Private to the current user. + "starTime": "A String", # Set if the entry is starred; unset otherwise. + "starred": True or False, # True if the entry is starred by the user; false otherwise. + }, "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. "importedLibraries": [ # Paths of the imported libraries. @@ -300,6 +310,10 @@

Method Details

}, "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + "personalDetails": { # Entry metadata relevant only to the user and private to them. # Output only. Additional information related to the entry. Private to the current user. + "starTime": "A String", # Set if the entry is starred; unset otherwise. + "starred": True or False, # True if the entry is starred by the user; false otherwise. + }, "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. "importedLibraries": [ # Paths of the imported libraries. @@ -444,6 +458,10 @@

Method Details

}, "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + "personalDetails": { # Entry metadata relevant only to the user and private to them. # Output only. Additional information related to the entry. Private to the current user. + "starTime": "A String", # Set if the entry is starred; unset otherwise. + "starred": True or False, # True if the entry is starred by the user; false otherwise. + }, "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. "importedLibraries": [ # Paths of the imported libraries. @@ -508,7 +526,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -618,6 +636,10 @@

Method Details

}, "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + "personalDetails": { # Entry metadata relevant only to the user and private to them. # Output only. Additional information related to the entry. Private to the current user. + "starTime": "A String", # Set if the entry is starred; unset otherwise. + "starred": True or False, # True if the entry is starred by the user; false otherwise. + }, "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. "importedLibraries": [ # Paths of the imported libraries. @@ -756,6 +778,10 @@

Method Details

}, "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + "personalDetails": { # Entry metadata relevant only to the user and private to them. # Output only. Additional information related to the entry. Private to the current user. + "starTime": "A String", # Set if the entry is starred; unset otherwise. + "starred": True or False, # True if the entry is starred by the user; false otherwise. + }, "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. "importedLibraries": [ # Paths of the imported libraries. @@ -876,6 +902,10 @@

Method Details

}, "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + "personalDetails": { # Entry metadata relevant only to the user and private to them. # Output only. Additional information related to the entry. Private to the current user. + "starTime": "A String", # Set if the entry is starred; unset otherwise. + "starred": True or False, # True if the entry is starred by the user; false otherwise. + }, "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. "importedLibraries": [ # Paths of the imported libraries. @@ -929,6 +959,30 @@

Method Details

}
+
+ star(name, body=None, x__xgafv=None) +
Marks an Entry as starred by the current user. Starring information is private to each user.
+
+Args:
+  name: string, Required. The name of the entry to mark as starred. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for StarEntry.
+}
+
+  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 StarEntry. Empty for now
+}
+
+
testIamPermissions(resource, body=None, x__xgafv=None)
Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.
@@ -959,4 +1013,28 @@ 

Method Details

}
+
+ unstar(name, body=None, x__xgafv=None) +
Marks an Entry as NOT starred by the current user. Starring information is private to each user.
+
+Args:
+  name: string, Required. The name of the entry to mark as **not** starred. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UnstarEntry.
+}
+
+  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 UnstarEntry. Empty for now
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html index a1d2f3ecce1..11ae5dd03ae 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a tag and assigns it to: * An Entry if the method name is ``projects.locations.entryGroups.entries.tags.create``. * Or EntryGroupif the method name is ``projects.locations.entryGroups.tags.create``. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

+

Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

delete(name, x__xgafv=None)

Deletes a tag.

@@ -100,7 +100,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a tag and assigns it to: * An Entry if the method name is ``projects.locations.entryGroups.entries.tags.create``. * Or EntryGroupif the method name is ``projects.locations.entryGroups.tags.create``. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
+  
Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
 
 Args:
   parent: string, Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. (required)
diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html
index 52246bf6b7d..c0682861862 100644
--- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html
+++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html
@@ -218,7 +218,7 @@ 

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html index 48ac2bab483..a6406fa6824 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a tag and assigns it to: * An Entry if the method name is ``projects.locations.entryGroups.entries.tags.create``. * Or EntryGroupif the method name is ``projects.locations.entryGroups.tags.create``. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

+

Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

delete(name, x__xgafv=None)

Deletes a tag.

@@ -100,7 +100,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a tag and assigns it to: * An Entry if the method name is ``projects.locations.entryGroups.entries.tags.create``. * Or EntryGroupif the method name is ``projects.locations.entryGroups.tags.create``. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
+  
Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
 
 Args:
   parent: string, Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. (required)
diff --git a/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.fields.html b/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.fields.html
index 80f4838e217..45a5040a26e 100644
--- a/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.fields.html
+++ b/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.fields.html
@@ -234,7 +234,7 @@ 

Method Details

Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 
 Args:
-  name: string, Required. The name of the tag template. (required)
+  name: string, Required. The name of the tag template field. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html b/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html
index 08e8da3f5ce..01c3244be42 100644
--- a/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html
+++ b/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html
@@ -248,7 +248,7 @@ 

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -314,7 +314,7 @@

Method Details

"name": "A String", # The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name. } - updateMask: string, Names of fields whose values to overwrite on a tag template. Currently, only `display_name` and `is_publicly_readable` can be overwritten. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the ``is_publicly_readable`` field may require up to 12 hours to take effect in search results. Additionally, it also requires the ``tagTemplates.getIamPolicy`` and ``tagTemplates.setIamPolicy`` permissions. + updateMask: string, Names of fields whose values to overwrite on a tag template. Currently, only `display_name` and `is_publicly_readable` can be overwritten. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the `is_publicly_readable` field may require up to 12 hours to take effect in search results. Additionally, it also requires the `tagTemplates.getIamPolicy` and `tagTemplates.setIamPolicy` permissions. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datacatalog_v1.projects.locations.taxonomies.html b/docs/dyn/datacatalog_v1.projects.locations.taxonomies.html index 2498b2baf88..a1988b4e62f 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.taxonomies.html +++ b/docs/dyn/datacatalog_v1.projects.locations.taxonomies.html @@ -270,7 +270,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/datacatalog_v1.projects.locations.taxonomies.policyTags.html b/docs/dyn/datacatalog_v1.projects.locations.taxonomies.policyTags.html index ec8120b958a..fc3658c9a37 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.taxonomies.policyTags.html +++ b/docs/dyn/datacatalog_v1.projects.locations.taxonomies.policyTags.html @@ -202,7 +202,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/datacatalog_v1beta1.catalog.html b/docs/dyn/datacatalog_v1beta1.catalog.html index 50f245f0ea1..566ec892123 100644 --- a/docs/dyn/datacatalog_v1beta1.catalog.html +++ b/docs/dyn/datacatalog_v1beta1.catalog.html @@ -98,7 +98,7 @@

Method Details

The object takes the form of: { # Request message for SearchCatalog. - "orderBy": "A String", # Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified If not specified, defaults to `relevance` descending. + "orderBy": "A String", # Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified * `default` that can only be descending If not specified, defaults to `relevance` descending. "pageSize": 42, # Number of results in the search page. If <=0 then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000. "pageToken": "A String", # Optional. Pagination token returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest call, and that the system should return the next page of data. If empty, the first page is returned. "query": "A String", # Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to. Query strings can be simple as "x" or more qualified as: * name:x * column:x * description:y Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information. diff --git a/docs/dyn/datacatalog_v1beta1.entries.html b/docs/dyn/datacatalog_v1beta1.entries.html index 253a43a4748..72212ba54ef 100644 --- a/docs/dyn/datacatalog_v1beta1.entries.html +++ b/docs/dyn/datacatalog_v1beta1.entries.html @@ -92,7 +92,7 @@

Method Details

Args: linkedResource: string, The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive. Examples: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId * //pubsub.googleapis.com/projects/projectId/topics/topicId - sqlResource: string, The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. + sqlResource: string, The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s should satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -159,7 +159,7 @@

Method Details

"usageSignal": { # The set of all usage signals that we store in Data Catalog. # Output only. Statistics on the usage level of the resource. "updateTime": "A String", # The timestamp of the end of the usage statistics duration. "usageWithinTimeRange": { # Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}. - "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables + "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables "totalCancellations": 3.14, # The number of times that the underlying entry was attempted to be used but was cancelled by the user. "totalCompletions": 3.14, # The number of times that the underlying entry was successfully used. "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent (in milliseconds) during uses the resulted in completions. diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.html b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.html index 0c6d7c58e5a..c39601c165f 100644 --- a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.html @@ -179,7 +179,7 @@

Method Details

"usageSignal": { # The set of all usage signals that we store in Data Catalog. # Output only. Statistics on the usage level of the resource. "updateTime": "A String", # The timestamp of the end of the usage statistics duration. "usageWithinTimeRange": { # Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}. - "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables + "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables "totalCancellations": 3.14, # The number of times that the underlying entry was attempted to be used but was cancelled by the user. "totalCompletions": 3.14, # The number of times that the underlying entry was successfully used. "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent (in milliseconds) during uses the resulted in completions. @@ -258,7 +258,7 @@

Method Details

"usageSignal": { # The set of all usage signals that we store in Data Catalog. # Output only. Statistics on the usage level of the resource. "updateTime": "A String", # The timestamp of the end of the usage statistics duration. "usageWithinTimeRange": { # Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}. - "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables + "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables "totalCancellations": 3.14, # The number of times that the underlying entry was attempted to be used but was cancelled by the user. "totalCompletions": 3.14, # The number of times that the underlying entry was successfully used. "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent (in milliseconds) during uses the resulted in completions. @@ -361,7 +361,7 @@

Method Details

"usageSignal": { # The set of all usage signals that we store in Data Catalog. # Output only. Statistics on the usage level of the resource. "updateTime": "A String", # The timestamp of the end of the usage statistics duration. "usageWithinTimeRange": { # Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}. - "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables + "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables "totalCancellations": 3.14, # The number of times that the underlying entry was attempted to be used but was cancelled by the user. "totalCompletions": 3.14, # The number of times that the underlying entry was successfully used. "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent (in milliseconds) during uses the resulted in completions. @@ -385,7 +385,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -494,7 +494,7 @@

Method Details

"usageSignal": { # The set of all usage signals that we store in Data Catalog. # Output only. Statistics on the usage level of the resource. "updateTime": "A String", # The timestamp of the end of the usage statistics duration. "usageWithinTimeRange": { # Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}. - "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables + "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables "totalCancellations": 3.14, # The number of times that the underlying entry was attempted to be used but was cancelled by the user. "totalCompletions": 3.14, # The number of times that the underlying entry was successfully used. "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent (in milliseconds) during uses the resulted in completions. @@ -591,7 +591,7 @@

Method Details

"usageSignal": { # The set of all usage signals that we store in Data Catalog. # Output only. Statistics on the usage level of the resource. "updateTime": "A String", # The timestamp of the end of the usage statistics duration. "usageWithinTimeRange": { # Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}. - "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables + "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables "totalCancellations": 3.14, # The number of times that the underlying entry was attempted to be used but was cancelled by the user. "totalCompletions": 3.14, # The number of times that the underlying entry was successfully used. "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent (in milliseconds) during uses the resulted in completions. @@ -670,7 +670,7 @@

Method Details

"usageSignal": { # The set of all usage signals that we store in Data Catalog. # Output only. Statistics on the usage level of the resource. "updateTime": "A String", # The timestamp of the end of the usage statistics duration. "usageWithinTimeRange": { # Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}. - "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables + "a_key": { # Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables "totalCancellations": 3.14, # The number of times that the underlying entry was attempted to be used but was cancelled by the user. "totalCompletions": 3.14, # The number of times that the underlying entry was successfully used. "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent (in milliseconds) during uses the resulted in completions. diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.tags.html b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.tags.html index e436380cbef..91c2791a0ab 100644 --- a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.tags.html +++ b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.entries.tags.html @@ -85,7 +85,7 @@

Instance Methods

Deletes a tag.

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

-

Lists the tags on an Entry.

+

Lists tags assigned to an Entry. The columns in the response are lowercased.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -176,7 +176,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the tags on an Entry.
+  
Lists tags assigned to an Entry. The columns in the response are lowercased.
 
 Args:
   parent: string, Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} (required)
diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.html b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.html
index a1300427caa..4c0dc092d38 100644
--- a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.html
+++ b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.html
@@ -218,7 +218,7 @@ 

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.tags.html b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.tags.html index eae557d16af..39c88b6919c 100644 --- a/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.tags.html +++ b/docs/dyn/datacatalog_v1beta1.projects.locations.entryGroups.tags.html @@ -85,7 +85,7 @@

Instance Methods

Deletes a tag.

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

-

Lists the tags on an Entry.

+

Lists tags assigned to an Entry. The columns in the response are lowercased.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -176,7 +176,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the tags on an Entry.
+  
Lists tags assigned to an Entry. The columns in the response are lowercased.
 
 Args:
   parent: string, Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} (required)
diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html b/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html
index 4f4a7cc7ce6..d8413e3297c 100644
--- a/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html
+++ b/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html
@@ -245,7 +245,7 @@ 

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.html b/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.html index db3862c2f0e..3a24dcccab0 100644 --- a/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.html +++ b/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.html @@ -267,7 +267,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.policyTags.html b/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.policyTags.html index e923dd5308b..5e879f8601a 100644 --- a/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.policyTags.html +++ b/docs/dyn/datacatalog_v1beta1.projects.locations.taxonomies.policyTags.html @@ -202,7 +202,7 @@

Method Details

{ # Request message for `GetIamPolicy` method. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. - "requestedPolicyVersion": 42, # 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). + "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } diff --git a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html index 06c28c9fad5..2dbf23a11d5 100644 --- a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html @@ -127,6 +127,7 @@

Method Details

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database. "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives. "autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. + "cmekKeyName": "A String", # The KMS key name used for the csql instance. "collation": "A String", # The Cloud SQL default instance level collation. "dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. "dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`. @@ -296,6 +297,7 @@

Method Details

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database. "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives. "autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. + "cmekKeyName": "A String", # The KMS key name used for the csql instance. "collation": "A String", # The Cloud SQL default instance level collation. "dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. "dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`. @@ -382,7 +384,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -452,6 +454,7 @@

Method Details

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database. "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives. "autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. + "cmekKeyName": "A String", # The KMS key name used for the csql instance. "collation": "A String", # The Cloud SQL default instance level collation. "dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. "dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`. @@ -569,6 +572,7 @@

Method Details

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database. "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives. "autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. + "cmekKeyName": "A String", # The KMS key name used for the csql instance. "collation": "A String", # The Cloud SQL default instance level collation. "dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. "dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`. diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index e030846fd60..3cfab408640 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -356,7 +356,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datamigration_v1beta1.projects.locations.connectionProfiles.html b/docs/dyn/datamigration_v1beta1.projects.locations.connectionProfiles.html index 864d5e2611c..10887c3de13 100644 --- a/docs/dyn/datamigration_v1beta1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datamigration_v1beta1.projects.locations.connectionProfiles.html @@ -352,7 +352,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datamigration_v1beta1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1beta1.projects.locations.migrationJobs.html index e86092bbdf2..c3c8c785041 100644 --- a/docs/dyn/datamigration_v1beta1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1beta1.projects.locations.migrationJobs.html @@ -356,7 +356,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datapipelines_v1.projects.locations.html b/docs/dyn/datapipelines_v1.projects.locations.html index fa95dda142f..b95ccbd641b 100644 --- a/docs/dyn/datapipelines_v1.projects.locations.html +++ b/docs/dyn/datapipelines_v1.projects.locations.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

listPipelines(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists pipelines. Returns a "NOT_FOUND" error if the list is empty. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

+

Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

listPipelines_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -96,11 +96,11 @@

Method Details

listPipelines(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists pipelines. Returns a "NOT_FOUND" error if the list is empty. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
+  
Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
 
 Args:
   parent: string, Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. (required)
-  filter: string, An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `executor_type`: The type of pipeline execution layer. This is always Dataflow for now, but more executors may be added later. Allowed values are `ALL` and `DATAFLOW`. + `status`: The activity status of the pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE
+  filter: string, An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `status`: The activity status of the pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE
   pageSize: integer, The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit is yet to be determined by the backend implementation.
   pageToken: string, A page token, received from a previous `ListPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPipelines` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -114,12 +114,12 @@ 

Method Details

{ # Response message for ListPipelines. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "pipelines": [ # Results that matched the filter criteria and were accessible to the caller. Results are always in descending order of pipeline creation date. - { # The main pipeline entity and all the needed metadata to launch and manage linked jobs. + { # The main pipeline entity and all the necessary metadata for launching and managing linked jobs. "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). "jobCount": 42, # Output only. Number of jobs. "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. - "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. + "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. "pipelineSources": { # Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. "a_key": "A String", }, diff --git a/docs/dyn/datapipelines_v1.projects.locations.pipelines.html b/docs/dyn/datapipelines_v1.projects.locations.pipelines.html index 2f7291879fc..aa3a61e2623 100644 --- a/docs/dyn/datapipelines_v1.projects.locations.pipelines.html +++ b/docs/dyn/datapipelines_v1.projects.locations.pipelines.html @@ -88,13 +88,13 @@

Instance Methods

Looks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

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

-

Updates a pipeline. If successful, the updated [Pipeline] is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.

+

Updates a pipeline. If successful, the updated Pipeline is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.

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

-

Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FOBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.

+

Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.

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

-

Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained. Upon success, the pipeline state is updated to ARCHIVED.

+

Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained.

Method Details

close() @@ -110,12 +110,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The main pipeline entity and all the needed metadata to launch and manage linked jobs. +{ # The main pipeline entity and all the necessary metadata for launching and managing linked jobs. "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). "jobCount": 42, # Output only. Number of jobs. "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. - "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. + "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. "pipelineSources": { # Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. "a_key": "A String", }, @@ -218,12 +218,12 @@

Method Details

Returns: An object of the form: - { # The main pipeline entity and all the needed metadata to launch and manage linked jobs. + { # The main pipeline entity and all the necessary metadata for launching and managing linked jobs. "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). "jobCount": 42, # Output only. Number of jobs. "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. - "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. + "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. "pipelineSources": { # Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. "a_key": "A String", }, @@ -342,7 +342,7 @@

Method Details

Looks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
 
 Args:
-  name: string, Required. The pipeeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
+  name: string, Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -351,12 +351,12 @@ 

Method Details

Returns: An object of the form: - { # The main pipeline entity and all the needed metadata to launch and manage linked jobs. + { # The main pipeline entity and all the necessary metadata for launching and managing linked jobs. "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). "jobCount": 42, # Output only. Number of jobs. "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. - "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. + "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. "pipelineSources": { # Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. "a_key": "A String", }, @@ -454,19 +454,19 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a pipeline. If successful, the updated [Pipeline] is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.
+  
Updates a pipeline. If successful, the updated Pipeline is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.
 
 Args:
-  name: string, The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. (required)
+  name: string, The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # The main pipeline entity and all the needed metadata to launch and manage linked jobs.
+{ # The main pipeline entity and all the necessary metadata for launching and managing linked jobs.
   "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
   "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
   "jobCount": 42, # Output only. Number of jobs.
   "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
-  "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
+  "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.
   "pipelineSources": { # Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation.
     "a_key": "A String",
   },
@@ -570,12 +570,12 @@ 

Method Details

Returns: An object of the form: - { # The main pipeline entity and all the needed metadata to launch and manage linked jobs. + { # The main pipeline entity and all the necessary metadata for launching and managing linked jobs. "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). "jobCount": 42, # Output only. Number of jobs. "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. - "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. + "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. "pipelineSources": { # Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. "a_key": "A String", }, @@ -673,7 +673,7 @@

Method Details

run(name, body=None, x__xgafv=None) -
Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FOBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.
+  
Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.
 
 Args:
   name: string, Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
@@ -724,7 +724,7 @@ 

Method Details

stop(name, body=None, x__xgafv=None) -
Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained. Upon success, the pipeline state is updated to ARCHIVED.
+  
Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained.
 
 Args:
   name: string, Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. (required)
@@ -742,12 +742,12 @@ 

Method Details

Returns: An object of the form: - { # The main pipeline entity and all the needed metadata to launch and manage linked jobs. + { # The main pipeline entity and all the necessary metadata for launching and managing linked jobs. "createTime": "A String", # Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. "displayName": "A String", # Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). "jobCount": 42, # Output only. Number of jobs. "lastUpdateTime": "A String", # Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. - "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. + "name": "A String", # The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. "pipelineSources": { # Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. "a_key": "A String", }, diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index 4d0b547a4ae..7ddd9546dd9 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -232,7 +232,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -368,7 +368,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -529,7 +529,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -676,7 +676,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -831,7 +831,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -968,7 +968,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index c7187d8449f..af28f9e4f04 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -232,7 +232,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -368,7 +368,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -529,7 +529,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -676,7 +676,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -831,7 +831,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -968,7 +968,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index d291b03ee0a..b583f00a3de 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -232,7 +232,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -368,7 +368,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -529,7 +529,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -676,7 +676,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -831,7 +831,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -968,7 +968,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index 33419ce3758..e4bad7722f2 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -232,7 +232,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -368,7 +368,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -529,7 +529,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -676,7 +676,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -831,7 +831,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. @@ -968,7 +968,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "speechModelVariant": "A String", # Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. + "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. }, "timeZone": "A String", # The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York. "updateTime": "A String", # Output only. Update time of the conversation profile. diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index d1c0f4362a9..c49294006b4 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -311,6 +311,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 31507cfff5b..7d8534f8e45 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -306,6 +306,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -592,6 +597,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -900,6 +910,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1202,6 +1217,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1505,6 +1525,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1790,6 +1815,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 8e87ec6922e..ba24cd1267d 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -310,6 +310,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -723,6 +728,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1708,6 +1718,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2687,6 +2702,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 880c64fa025..39953de2beb 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -315,6 +315,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1282,6 +1287,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1568,6 +1578,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1876,6 +1891,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2178,6 +2198,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2481,6 +2506,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2766,6 +2796,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 9ee100eb4ab..b16ce51b0c5 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -316,6 +316,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -729,6 +734,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1738,6 +1748,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2805,6 +2820,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 511af1507c6..c2d82d1728d 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -318,6 +318,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1285,6 +1290,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1571,6 +1581,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -1879,6 +1894,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2269,6 +2289,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2572,6 +2597,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", @@ -2857,6 +2887,11 @@

Method Details

"name": "A String", # Name describing the field. }, ], + "includedFields": [ # Limit scanning only to these fields. + { # General identifier of a data field in a storage service. + "name": "A String", # Name describing the field. + }, + ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. "sampleMethod": "A String", diff --git a/docs/dyn/dns_v1.html b/docs/dyn/dns_v1.html index 586d7e096c4..b22ae6a3675 100644 --- a/docs/dyn/dns_v1.html +++ b/docs/dyn/dns_v1.html @@ -109,6 +109,16 @@

Instance Methods

Returns the resourceRecordSets Resource.

+

+ responsePolicies() +

+

Returns the responsePolicies Resource.

+ +

+ responsePolicyRules() +

+

Returns the responsePolicyRules Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/dns_v1.responsePolicies.html b/docs/dyn/dns_v1.responsePolicies.html new file mode 100644 index 00000000000..5bf48d6fb8a --- /dev/null +++ b/docs/dyn/dns_v1.responsePolicies.html @@ -0,0 +1,351 @@ + + + +

Cloud DNS API . responsePolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(project, body=None, clientOperationId=None, x__xgafv=None)

+

Creates a new Response Policy

+

+ delete(project, responsePolicy, clientOperationId=None, x__xgafv=None)

+

Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.

+

+ get(project, responsePolicy, clientOperationId=None, x__xgafv=None)

+

Fetches the representation of an existing Response Policy.

+

+ list(project, maxResults=None, pageToken=None, x__xgafv=None)

+

Enumerates all Response Policies associated with a project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)

+

Applies a partial update to an existing Response Policy.

+

+ update(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)

+

Updates an existing Response Policy.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(project, body=None, clientOperationId=None, x__xgafv=None) +
Creates a new Response Policy
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+  "description": "A String", # User-provided description for this Response Policy.
+  "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+  "kind": "dns#responsePolicy",
+  "networks": [ # List of network names specifying networks to which this policy is applied.
+    {
+      "kind": "dns#responsePolicyNetwork",
+      "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+    },
+  ],
+  "responsePolicyName": "A String", # User assigned name for this Response Policy.
+}
+
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+  "description": "A String", # User-provided description for this Response Policy.
+  "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+  "kind": "dns#responsePolicy",
+  "networks": [ # List of network names specifying networks to which this policy is applied.
+    {
+      "kind": "dns#responsePolicyNetwork",
+      "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+    },
+  ],
+  "responsePolicyName": "A String", # User assigned name for this Response Policy.
+}
+
+ +
+ delete(project, responsePolicy, clientOperationId=None, x__xgafv=None) +
Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ +
+ get(project, responsePolicy, clientOperationId=None, x__xgafv=None) +
Fetches the representation of an existing Response Policy.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+  "description": "A String", # User-provided description for this Response Policy.
+  "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+  "kind": "dns#responsePolicy",
+  "networks": [ # List of network names specifying networks to which this policy is applied.
+    {
+      "kind": "dns#responsePolicyNetwork",
+      "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+    },
+  ],
+  "responsePolicyName": "A String", # User assigned name for this Response Policy.
+}
+
+ +
+ list(project, maxResults=None, pageToken=None, x__xgafv=None) +
Enumerates all Response Policies associated with a project.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
+  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue 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:
+
+    {
+  "header": { # Elements common to every response.
+    "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+  },
+  "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
+  "responsePolicies": [ # The Response Policy resources.
+    { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+      "description": "A String", # User-provided description for this Response Policy.
+      "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+      "kind": "dns#responsePolicy",
+      "networks": [ # List of network names specifying networks to which this policy is applied.
+        {
+          "kind": "dns#responsePolicyNetwork",
+          "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+        },
+      ],
+      "responsePolicyName": "A String", # User assigned name for this Response Policy.
+    },
+  ],
+}
+
+ +
+ 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(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None) +
Applies a partial update to an existing Response Policy.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Respones Policy addressed by this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+  "description": "A String", # User-provided description for this Response Policy.
+  "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+  "kind": "dns#responsePolicy",
+  "networks": [ # List of network names specifying networks to which this policy is applied.
+    {
+      "kind": "dns#responsePolicyNetwork",
+      "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+    },
+  ],
+  "responsePolicyName": "A String", # User assigned name for this Response Policy.
+}
+
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "header": { # Elements common to every response.
+    "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+  },
+  "responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+    "description": "A String", # User-provided description for this Response Policy.
+    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+    "kind": "dns#responsePolicy",
+    "networks": [ # List of network names specifying networks to which this policy is applied.
+      {
+        "kind": "dns#responsePolicyNetwork",
+        "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+      },
+    ],
+    "responsePolicyName": "A String", # User assigned name for this Response Policy.
+  },
+}
+
+ +
+ update(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None) +
Updates an existing Response Policy.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy addressed by this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+  "description": "A String", # User-provided description for this Response Policy.
+  "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+  "kind": "dns#responsePolicy",
+  "networks": [ # List of network names specifying networks to which this policy is applied.
+    {
+      "kind": "dns#responsePolicyNetwork",
+      "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+    },
+  ],
+  "responsePolicyName": "A String", # User assigned name for this Response Policy.
+}
+
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "header": { # Elements common to every response.
+    "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+  },
+  "responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
+    "description": "A String", # User-provided description for this Response Policy.
+    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+    "kind": "dns#responsePolicy",
+    "networks": [ # List of network names specifying networks to which this policy is applied.
+      {
+        "kind": "dns#responsePolicyNetwork",
+        "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+      },
+    ],
+    "responsePolicyName": "A String", # User assigned name for this Response Policy.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dns_v1.responsePolicyRules.html b/docs/dyn/dns_v1.responsePolicyRules.html new file mode 100644 index 00000000000..5e01ff944af --- /dev/null +++ b/docs/dyn/dns_v1.responsePolicyRules.html @@ -0,0 +1,437 @@ + + + +

Cloud DNS API . responsePolicyRules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None)

+

Creates a new Response Policy Rule.

+

+ delete(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)

+

Deletes a previously created Response Policy Rule.

+

+ get(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None)

+

Fetches the representation of an existing Response Policy Rule.

+

+ list(project, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None)

+

Enumerates all Response Policy Rules associated with a project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)

+

Applies a partial update to an existing Response Policy Rule.

+

+ update(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None)

+

Updates an existing Response Policy Rule.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(project, responsePolicy, body=None, clientOperationId=None, x__xgafv=None) +
Creates a new Response Policy Rule.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+  "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+  "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+  "kind": "dns#responsePolicyRule",
+  "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+    "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+      { # A unit of data that is returned by the DNS servers.
+        "kind": "dns#resourceRecordSet",
+        "name": "A String", # For example, www.example.com.
+        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+          "A String",
+        ],
+        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+          "A String",
+        ],
+        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+        "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+      },
+    ],
+  },
+  "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+}
+
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+  "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+  "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+  "kind": "dns#responsePolicyRule",
+  "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+    "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+      { # A unit of data that is returned by the DNS servers.
+        "kind": "dns#resourceRecordSet",
+        "name": "A String", # For example, www.example.com.
+        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+          "A String",
+        ],
+        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+          "A String",
+        ],
+        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+        "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+      },
+    ],
+  },
+  "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+}
+
+ +
+ delete(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None) +
Deletes a previously created Response Policy Rule.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
+  responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ +
+ get(project, responsePolicy, responsePolicyRule, clientOperationId=None, x__xgafv=None) +
Fetches the representation of an existing Response Policy Rule.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
+  responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+  "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+  "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+  "kind": "dns#responsePolicyRule",
+  "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+    "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+      { # A unit of data that is returned by the DNS servers.
+        "kind": "dns#resourceRecordSet",
+        "name": "A String", # For example, www.example.com.
+        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+          "A String",
+        ],
+        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+          "A String",
+        ],
+        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+        "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+      },
+    ],
+  },
+  "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+}
+
+ +
+ list(project, responsePolicy, maxResults=None, pageToken=None, x__xgafv=None) +
Enumerates all Response Policy Rules associated with a project.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy to list. (required)
+  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
+  pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue 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:
+
+    {
+  "header": { # Elements common to every response.
+    "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+  },
+  "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
+  "responsePolicyRules": [ # The Response Policy Rule resources.
+    { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+      "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+      "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+      "kind": "dns#responsePolicyRule",
+      "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+        "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+          { # A unit of data that is returned by the DNS servers.
+            "kind": "dns#resourceRecordSet",
+            "name": "A String", # For example, www.example.com.
+            "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+              "A String",
+            ],
+            "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+              "A String",
+            ],
+            "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+            "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+          },
+        ],
+      },
+      "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+    },
+  ],
+}
+
+ +
+ 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(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None) +
Applies a partial update to an existing Response Policy Rule.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
+  responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+  "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+  "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+  "kind": "dns#responsePolicyRule",
+  "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+    "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+      { # A unit of data that is returned by the DNS servers.
+        "kind": "dns#resourceRecordSet",
+        "name": "A String", # For example, www.example.com.
+        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+          "A String",
+        ],
+        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+          "A String",
+        ],
+        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+        "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+      },
+    ],
+  },
+  "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+}
+
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "header": { # Elements common to every response.
+    "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+  },
+  "responsePolicyRule": { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+    "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+    "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+    "kind": "dns#responsePolicyRule",
+    "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+      "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+        { # A unit of data that is returned by the DNS servers.
+          "kind": "dns#resourceRecordSet",
+          "name": "A String", # For example, www.example.com.
+          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+            "A String",
+          ],
+          "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+            "A String",
+          ],
+          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+          "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+        },
+      ],
+    },
+    "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+  },
+}
+
+ +
+ update(project, responsePolicy, responsePolicyRule, body=None, clientOperationId=None, x__xgafv=None) +
Updates an existing Response Policy Rule.
+
+Args:
+  project: string, Identifies the project addressed by this request. (required)
+  responsePolicy: string, User assigned name of the Response Policy containing the Response Policy Rule. (required)
+  responsePolicyRule: string, User assigned name of the Response Policy Rule addressed by this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+  "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+  "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+  "kind": "dns#responsePolicyRule",
+  "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+    "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+      { # A unit of data that is returned by the DNS servers.
+        "kind": "dns#resourceRecordSet",
+        "name": "A String", # For example, www.example.com.
+        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+          "A String",
+        ],
+        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+          "A String",
+        ],
+        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+        "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+      },
+    ],
+  },
+  "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+}
+
+  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "header": { # Elements common to every response.
+    "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+  },
+  "responsePolicyRule": { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
+    "behavior": "A String", # Answer this query with a behavior rather than DNS data.
+    "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
+    "kind": "dns#responsePolicyRule",
+    "localData": { # Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
+      "localDatas": [ # All resource record sets for this selector, one per resource record type. The name must match the dns_name.
+        { # A unit of data that is returned by the DNS servers.
+          "kind": "dns#resourceRecordSet",
+          "name": "A String", # For example, www.example.com.
+          "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
+            "A String",
+          ],
+          "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+            "A String",
+          ],
+          "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+          "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types.
+        },
+      ],
+    },
+    "ruleName": "A String", # An identifier for this rule. Must be unique with the ResponsePolicy.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/documentai_v1.projects.locations.html b/docs/dyn/documentai_v1.projects.locations.html index 02641b33905..88831a483ba 100644 --- a/docs/dyn/documentai_v1.projects.locations.html +++ b/docs/dyn/documentai_v1.projects.locations.html @@ -110,7 +110,7 @@

Method Details

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)
+  parent: string, Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -121,8 +121,8 @@ 

Method Details

{ # 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: 9. - "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 request access. + { # A processor type is responsible for performing a certain document understanding task on a certain type of document. + "allowCreation": True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. "availableLocations": [ # The locations in which this processor is available. { # The location information about where the processor is available. "locationId": "A String", # The location id, currently must be one of [us, eu]. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index a8a39d7bbd5..b1149a5623e 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -123,7 +123,7 @@

Method Details

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
 
 Args:
-  name: string, Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -188,16 +188,16 @@ 

Method Details

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)
+  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.
+{ # The first-class citizen for Document AI. 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}
+  "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.
@@ -211,12 +211,12 @@ 

Method Details

Returns: An object of the form: - { # The first-class citizen for DAI. Each processor defines how to extract structural information from a document. + { # The first-class citizen for Document AI. 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} + "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. @@ -354,12 +354,12 @@

Method Details

Returns: An object of the form: - { # The first-class citizen for DAI. Each processor defines how to extract structural information from a document. + { # The first-class citizen for Document AI. 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} + "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. @@ -371,7 +371,7 @@

Method Details

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)
+  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.
@@ -385,12 +385,12 @@ 

Method Details

{ # 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. + { # The first-class citizen for Document AI. 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} + "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. @@ -418,7 +418,7 @@

Method Details

Processes a single document.
 
 Args:
-  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -426,7 +426,7 @@ 

Method Details

"inlineDocument": { # 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. # An inline document proto. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -476,7 +476,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -508,10 +508,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -587,10 +587,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -676,10 +676,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -765,10 +765,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -815,10 +815,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -829,10 +829,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1002,10 +1002,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1073,6 +1073,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -1089,10 +1092,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1163,7 +1166,7 @@

Method Details

"document": { # 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. # The document payload, will populate fields based on the processor's behavior. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -1213,7 +1216,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -1245,10 +1248,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1324,10 +1327,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1413,10 +1416,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1502,10 +1505,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1552,10 +1555,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1566,10 +1569,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1739,10 +1742,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1810,6 +1813,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -1826,10 +1832,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html index dc23bee72ca..7f0253bd41d 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html @@ -95,12 +95,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request message for review document method. Next Id: 6. +{ # Request message for review document method. "enableSchemaValidation": True or False, # Whether the validation should be performed on the ad-hoc review request. "inlineDocument": { # 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. # An inline document proto. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -150,7 +150,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -182,10 +182,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -261,10 +261,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -350,10 +350,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -439,10 +439,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -489,10 +489,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -503,10 +503,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -676,10 +676,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -747,6 +747,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -763,10 +766,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index d684be7a575..5e222091c5d 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -107,7 +107,7 @@

Method Details

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
 
 Args:
-  name: string, Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -260,7 +260,7 @@ 

Method Details

{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version. "createTime": "A String", # The time the processor version was created. "displayName": "A String", # The display name of the processor version. - "name": "A String", # The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version} + "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` "state": "A String", # The state of the processor version. }
@@ -270,7 +270,7 @@

Method Details

Lists all versions of a processor.
 
 Args:
-  parent: string, Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor} (required)
+  parent: string, Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}` (required)
   pageSize: integer, The maximum number of processor versions to return. If unspecified, at most 10 processor versions will be returned. The maximum value is 20; values above 20 will be coerced to 20.
   pageToken: string, We will return the processor versions sorted by creation time. The page token will point to the next processor version.
   x__xgafv: string, V1 error format.
@@ -287,7 +287,7 @@ 

Method Details

{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version. "createTime": "A String", # The time the processor version was created. "displayName": "A String", # The display name of the processor version. - "name": "A String", # The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version} + "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` "state": "A String", # The state of the processor version. }, ], @@ -313,7 +313,7 @@

Method Details

Processes a single document.
 
 Args:
-  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -321,7 +321,7 @@ 

Method Details

"inlineDocument": { # 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. # An inline document proto. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -371,7 +371,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -403,10 +403,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -482,10 +482,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -571,10 +571,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -660,10 +660,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -710,10 +710,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -724,10 +724,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -897,10 +897,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -968,6 +968,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -984,10 +987,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1058,7 +1061,7 @@

Method Details

"document": { # 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. # The document payload, will populate fields based on the processor's behavior. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -1108,7 +1111,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -1140,10 +1143,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1219,10 +1222,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1308,10 +1311,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1397,10 +1400,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1447,10 +1450,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1461,10 +1464,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1634,10 +1637,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1705,6 +1708,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -1721,10 +1727,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/documentai_v1beta2.projects.documents.html b/docs/dyn/documentai_v1beta2.projects.documents.html index c9ff699207b..998b532c484 100644 --- a/docs/dyn/documentai_v1beta2.projects.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.documents.html @@ -287,7 +287,7 @@

Method Details

{ # 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. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -337,7 +337,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -369,10 +369,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -455,10 +455,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -544,10 +544,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -633,10 +633,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -683,10 +683,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -697,10 +697,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -870,10 +870,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -941,6 +941,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -957,10 +960,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/documentai_v1beta2.projects.locations.documents.html b/docs/dyn/documentai_v1beta2.projects.locations.documents.html index 54d742425a4..ba5f8074092 100644 --- a/docs/dyn/documentai_v1beta2.projects.locations.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.locations.documents.html @@ -287,7 +287,7 @@

Method Details

{ # 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. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -337,7 +337,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -369,10 +369,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -455,10 +455,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -544,10 +544,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -633,10 +633,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -683,10 +683,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -697,10 +697,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -870,10 +870,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -941,6 +941,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -957,10 +960,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.html b/docs/dyn/documentai_v1beta3.projects.locations.html index 74116a40cec..447f5129292 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.html @@ -110,7 +110,7 @@

Method Details

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)
+  parent: string, Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -121,8 +121,8 @@ 

Method Details

{ # 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: 9. - "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 request access. + { # A processor type is responsible for performing a certain document understanding task on a certain type of document. + "allowCreation": True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. "availableLocations": [ # The locations in which this processor is available. { # The location information about where the processor is available. "locationId": "A String", # The location id, currently must be one of [us, eu]. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 0d0828c7360..d0d7e86cc7f 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -123,7 +123,7 @@

Method Details

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
 
 Args:
-  name: string, Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -197,16 +197,16 @@ 

Method Details

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)
+  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.
+{ # The first-class citizen for Document AI. 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}
+  "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.
@@ -220,12 +220,12 @@ 

Method Details

Returns: An object of the form: - { # The first-class citizen for DAI. Each processor defines how to extract structural information from a document. + { # The first-class citizen for Document AI. 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} + "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. @@ -363,12 +363,12 @@

Method Details

Returns: An object of the form: - { # The first-class citizen for DAI. Each processor defines how to extract structural information from a document. + { # The first-class citizen for Document AI. 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} + "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. @@ -380,7 +380,7 @@

Method Details

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)
+  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.
@@ -394,12 +394,12 @@ 

Method Details

{ # 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. + { # The first-class citizen for Document AI. 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} + "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. @@ -427,7 +427,7 @@

Method Details

Processes a single document.
 
 Args:
-  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -435,7 +435,7 @@ 

Method Details

"document": { # 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. # The document payload, the [content] and [mime_type] fields must be set. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -485,7 +485,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -517,10 +517,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -596,10 +596,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -685,10 +685,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -774,10 +774,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -824,10 +824,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -838,10 +838,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1011,10 +1011,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1082,6 +1082,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -1098,10 +1101,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1156,7 +1159,7 @@

Method Details

"inlineDocument": { # 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. # An inline document proto. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -1206,7 +1209,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -1238,10 +1241,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1317,10 +1320,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1406,10 +1409,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1495,10 +1498,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1545,10 +1548,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1559,10 +1562,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1732,10 +1735,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1803,6 +1806,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -1819,10 +1825,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1893,7 +1899,7 @@

Method Details

"document": { # 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. # The document payload, will populate fields based on the processor's behavior. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -1943,7 +1949,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -1975,10 +1981,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2054,10 +2060,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2143,10 +2149,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2232,10 +2238,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2282,10 +2288,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2296,10 +2302,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2469,10 +2475,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2540,6 +2546,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -2556,10 +2565,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html index 1b2f02b87ac..75bee05102e 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html @@ -95,11 +95,11 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request message for review document method. Next Id: 6. +{ # Request message for review document method. "document": { # 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. # The document that needs human review. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -149,7 +149,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -181,10 +181,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -260,10 +260,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -349,10 +349,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -438,10 +438,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -488,10 +488,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -502,10 +502,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -675,10 +675,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -746,6 +746,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -762,10 +765,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -821,7 +824,7 @@

Method Details

"inlineDocument": { # 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. # An inline document proto. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -871,7 +874,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -903,10 +906,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -982,10 +985,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1071,10 +1074,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1160,10 +1163,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1210,10 +1213,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1224,10 +1227,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1397,10 +1400,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1468,6 +1471,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -1484,10 +1490,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 0aa447d1862..1fe6694b05d 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -107,7 +107,7 @@

Method Details

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
 
 Args:
-  name: string, Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -269,7 +269,7 @@ 

Method Details

{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version. "createTime": "A String", # The time the processor version was created. "displayName": "A String", # The display name of the processor version. - "name": "A String", # The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version} + "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` "state": "A String", # The state of the processor version. }
@@ -279,7 +279,7 @@

Method Details

Lists all versions of a processor.
 
 Args:
-  parent: string, Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor} (required)
+  parent: string, Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}` (required)
   pageSize: integer, The maximum number of processor versions to return. If unspecified, at most 10 processor versions will be returned. The maximum value is 20; values above 20 will be coerced to 20.
   pageToken: string, We will return the processor versions sorted by creation time. The page token will point to the next processor version.
   x__xgafv: string, V1 error format.
@@ -296,7 +296,7 @@ 

Method Details

{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version. "createTime": "A String", # The time the processor version was created. "displayName": "A String", # The display name of the processor version. - "name": "A String", # The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version} + "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` "state": "A String", # The state of the processor version. }, ], @@ -322,7 +322,7 @@

Method Details

Processes a single document.
 
 Args:
-  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} (required)
+  name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -330,7 +330,7 @@ 

Method Details

"document": { # 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. # The document payload, the [content] and [mime_type] fields must be set. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -380,7 +380,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -412,10 +412,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -491,10 +491,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -580,10 +580,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -669,10 +669,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -719,10 +719,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -733,10 +733,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -906,10 +906,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -977,6 +977,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -993,10 +996,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1051,7 +1054,7 @@

Method Details

"inlineDocument": { # 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. # An inline document proto. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -1101,7 +1104,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -1133,10 +1136,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1212,10 +1215,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1301,10 +1304,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1390,10 +1393,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1440,10 +1443,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1454,10 +1457,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1627,10 +1630,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1698,6 +1701,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -1714,10 +1720,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1788,7 +1794,7 @@

Method Details

"document": { # 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. # The document payload, will populate fields based on the processor's behavior. "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - { # An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location. + { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1]. "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document. "mentionId": "A String", # Optional. Deprecated. Use `id` field instead. @@ -1838,7 +1844,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. "pageRefs": [ # One or more references to visual page elements @@ -1870,10 +1876,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -1949,10 +1955,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2038,10 +2044,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2127,10 +2133,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2177,10 +2183,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2191,10 +2197,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2364,10 +2370,10 @@

Method Details

"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. @@ -2435,6 +2441,9 @@

Method Details

"parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], + "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + "A String", + ], "processor": "A String", # If the annotation was made by processor identify the processor by its resource name. }, ], @@ -2451,10 +2460,10 @@

Method Details

{ # Structure to identify provenance relationships between annotations in different revisions. "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. - { # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced. + { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. "id": 42, # The id of the parent provenance. - "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision. - "revision": 42, # The index of the [Document.revisions] identifying the parent revision. + "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + "revision": 42, # The index of the index into current revision's parent_ids list. }, ], "revision": 42, # The index of the revision that produced this element. diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index 9746623607b..9300de13bdc 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -112,7 +112,7 @@

Instance Methods

Retrieves the next page of results.

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

-

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

+

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

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

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

@@ -2620,7 +2620,7 @@

Method Details

patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None) -
Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might might change automatically, such as modifiedDate. This method supports patch semantics.
+  
Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
 
 Args:
   fileId: string, The ID of the file to update. (required)
diff --git a/docs/dyn/eventarc_v1.projects.locations.triggers.html b/docs/dyn/eventarc_v1.projects.locations.triggers.html
index 758385c1d69..fe05f85777c 100644
--- a/docs/dyn/eventarc_v1.projects.locations.triggers.html
+++ b/docs/dyn/eventarc_v1.projects.locations.triggers.html
@@ -122,7 +122,7 @@ 

Method Details

{ # A representation of the trigger resource. "createTime": "A String", # Output only. The creation time. "destination": { # Represents a target of an invocation over HTTP. # Required. Destination specifies where the events should be sent to. - "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger. + "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger. "path": "A String", # Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: "/route", "route", "route/subroute". "region": "A String", # Required. The region the Cloud Run service is deployed in. "service": "A String", # Required. The name of the Cloud Run service being addressed. See https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services. Only services located in the same project of the trigger object can be addressed. @@ -243,7 +243,7 @@

Method Details

{ # A representation of the trigger resource. "createTime": "A String", # Output only. The creation time. "destination": { # Represents a target of an invocation over HTTP. # Required. Destination specifies where the events should be sent to. - "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger. + "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger. "path": "A String", # Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: "/route", "route", "route/subroute". "region": "A String", # Required. The region the Cloud Run service is deployed in. "service": "A String", # Required. The name of the Cloud Run service being addressed. See https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services. Only services located in the same project of the trigger object can be addressed. @@ -350,7 +350,7 @@

Method Details

{ # A representation of the trigger resource. "createTime": "A String", # Output only. The creation time. "destination": { # Represents a target of an invocation over HTTP. # Required. Destination specifies where the events should be sent to. - "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger. + "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger. "path": "A String", # Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: "/route", "route", "route/subroute". "region": "A String", # Required. The region the Cloud Run service is deployed in. "service": "A String", # Required. The name of the Cloud Run service being addressed. See https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services. Only services located in the same project of the trigger object can be addressed. @@ -417,7 +417,7 @@

Method Details

{ # A representation of the trigger resource. "createTime": "A String", # Output only. The creation time. "destination": { # Represents a target of an invocation over HTTP. # Required. Destination specifies where the events should be sent to. - "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger. + "cloudRun": { # Represents a Cloud Run destination. # Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger. "path": "A String", # Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: "/route", "route", "route/subroute". "region": "A String", # Required. The region the Cloud Run service is deployed in. "service": "A String", # Required. The name of the Cloud Run service being addressed. See https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services. Only services located in the same project of the trigger object can be addressed. diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index ee7ffe36c93..f7cbfb5fdd4 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -175,11 +175,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -234,16 +230,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -263,11 +274,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -287,11 +294,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -312,7 +315,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -323,11 +345,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -359,16 +377,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -388,11 +421,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -412,11 +441,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -437,7 +462,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -471,11 +515,7 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -563,16 +603,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -592,11 +647,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -616,11 +667,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -641,7 +688,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -652,11 +718,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -688,16 +750,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -717,11 +794,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -741,11 +814,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -766,7 +835,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -790,11 +878,7 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -834,11 +918,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -876,11 +956,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -946,11 +1022,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1003,11 +1075,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1117,11 +1185,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1169,11 +1233,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1207,11 +1267,7 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1264,11 +1320,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1354,11 +1406,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1406,11 +1454,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1444,11 +1488,7 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1493,11 +1533,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1549,11 +1585,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1593,11 +1625,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1671,11 +1699,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1723,11 +1747,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1761,11 +1781,7 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1809,11 +1825,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1870,16 +1882,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1899,11 +1926,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1923,11 +1946,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1948,7 +1967,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -1959,11 +1997,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1995,16 +2029,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2024,11 +2073,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2048,11 +2093,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2073,7 +2114,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -2099,11 +2159,7 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. diff --git a/docs/dyn/gkehub_v1.projects.locations.memberships.html b/docs/dyn/gkehub_v1.projects.locations.memberships.html index e931fb60264..4e0566a8de6 100644 --- a/docs/dyn/gkehub_v1.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1.projects.locations.memberships.html @@ -161,6 +161,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -340,6 +341,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -475,6 +477,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -569,6 +572,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 5f6be6e5568..86cfcf22697 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -127,6 +127,10 @@

Method Details

}, "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. + "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec + "doNotOptimizeMetrics": True or False, # use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics + "enableStackdriverOnApplications": True or False, # enable collecting and reporting metrics and logs from user apps See go/onyx-application-metrics-logs-user-guide + }, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. "enabled": True or False, # Whether binauthz is enabled in this cluster. @@ -520,6 +524,10 @@

Method Details

}, "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. + "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec + "doNotOptimizeMetrics": True or False, # use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics + "enableStackdriverOnApplications": True or False, # enable collecting and reporting metrics and logs from user apps See go/onyx-application-metrics-logs-user-guide + }, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. "enabled": True or False, # Whether binauthz is enabled in this cluster. @@ -901,6 +909,10 @@

Method Details

}, "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. + "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec + "doNotOptimizeMetrics": True or False, # use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics + "enableStackdriverOnApplications": True or False, # enable collecting and reporting metrics and logs from user apps See go/onyx-application-metrics-logs-user-guide + }, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. "enabled": True or False, # Whether binauthz is enabled in this cluster. @@ -1238,6 +1250,10 @@

Method Details

}, "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. + "anthosobservability": { # **Anthosobservability**: Per-Membership Feature spec. # Anthos Observability-specific spec + "doNotOptimizeMetrics": True or False, # use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics + "enableStackdriverOnApplications": True or False, # enable collecting and reporting metrics and logs from user apps See go/onyx-application-metrics-logs-user-guide + }, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. "enabled": True or False, # Whether binauthz is enabled in this cluster. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html index afb187924bb..63ba5c03265 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html @@ -167,6 +167,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -346,6 +347,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -481,6 +483,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -572,6 +575,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -681,6 +685,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, diff --git a/docs/dyn/gkehub_v1alpha2.projects.locations.memberships.html b/docs/dyn/gkehub_v1alpha2.projects.locations.memberships.html index e79ac253549..651c4ac4838 100644 --- a/docs/dyn/gkehub_v1alpha2.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1alpha2.projects.locations.memberships.html @@ -161,6 +161,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -339,6 +340,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -475,6 +477,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -570,6 +573,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, diff --git a/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html b/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html index 128899f1355..0113c989a54 100644 --- a/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html @@ -167,6 +167,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -372,6 +373,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -510,6 +512,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, @@ -607,6 +610,7 @@

Method Details

], "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation. "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. + "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`. "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. }, }, diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.consentStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.consentStores.html index 8f1469760c0..511f2b3bb2e 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.consentStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.consentStores.html @@ -332,7 +332,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index 3248a322b16..fe8c29eaf11 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -205,7 +205,7 @@

Method Details

"fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. { # Specifies FHIR paths to match, and how to handle de-identification of matching fields. "action": "A String", # Deidentify action for one field. - "paths": [ # List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Base64Binary is also supported, but may only be kept as-is or have all the content removed. + "paths": [ # List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. "A String", ], }, @@ -371,7 +371,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html index b0f8a48ed4c..398b6c4b5b5 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html @@ -80,6 +80,9 @@

Instance Methods

Resource_purge(name, x__xgafv=None)

Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see [Deleting historical versions of a FHIR resource](/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_of_a_fhir_resource).

+

+ Resource_validate(parent, type, body=None, profile=None, x__xgafv=None)

+

Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

capabilities(name, x__xgafv=None)

Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.

@@ -166,6 +169,46 @@

Method Details

}
+
+ Resource_validate(parent, type, body=None, profile=None, x__xgafv=None) +
Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
+
+Args:
+  parent: string, The name of the FHIR store that holds the profiles being used for validation. (required)
+  type: string, The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # 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.
+    },
+  ],
+}
+
+  profile: string, A profile that this resource should be validated against.
+  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.
+    },
+  ],
+}
+
+
capabilities(name, x__xgafv=None)
Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
index 7566cc9b687..ada037bf716 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
@@ -163,8 +163,12 @@ 

Method Details

], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "A String", + ], }, "version": "A String", # Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. } @@ -208,8 +212,12 @@

Method Details

], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "A String", + ], }, "version": "A String", # Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. }
@@ -245,7 +253,7 @@

Method Details

"fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. { # Specifies FHIR paths to match, and how to handle de-identification of matching fields. "action": "A String", # Deidentify action for one field. - "paths": [ # List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Base64Binary is also supported, but may only be kept as-is or have all the content removed. + "paths": [ # List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. "A String", ], }, @@ -431,8 +439,12 @@

Method Details

], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "A String", + ], }, "version": "A String", # Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. }
@@ -444,7 +456,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -580,8 +592,12 @@

Method Details

], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "A String", + ], }, "version": "A String", # Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. }, @@ -643,8 +659,12 @@

Method Details

], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "A String", + ], }, "version": "A String", # Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. } @@ -688,8 +708,12 @@

Method Details

], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "A String", + ], }, "version": "A String", # Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. }
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html index cbfb0943446..4a799b992a6 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html @@ -202,7 +202,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. } @@ -288,7 +288,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }
@@ -446,7 +446,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }
@@ -458,7 +458,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -635,7 +635,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }, @@ -739,7 +739,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. } @@ -825,7 +825,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.html b/docs/dyn/healthcare_v1.projects.locations.datasets.html index c0eb8db3135..69903b78019 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.html @@ -212,7 +212,7 @@

Method Details

"fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. { # Specifies FHIR paths to match, and how to handle de-identification of matching fields. "action": "A String", # Deidentify action for one field. - "paths": [ # List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Base64Binary is also supported, but may only be kept as-is or have all the content removed. + "paths": [ # List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. "A String", ], }, @@ -320,7 +320,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html index 46042ebfee6..2e695ef8868 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.html @@ -320,7 +320,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.consentStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.consentStores.html index 9b75ac0207c..ade654fb419 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.consentStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.consentStores.html @@ -332,7 +332,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index fda7970d533..5cd6638be45 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -229,7 +229,7 @@

Method Details

"fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied. { # Specifies FHIR paths to match, and how to handle de-identification of matching fields. "action": "A String", # Deidentify action for one field. - "paths": [ # List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. The sub-type for HumanName, such as HumanName.given or HumanName.family, can be omitted. + "paths": [ # List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted. "A String", ], }, @@ -245,10 +245,10 @@

Method Details

"maskingCharacter": "A String", # Character to mask the sensitive values. If not supplied, defaults to "*". }, "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`. # Config for crypto hash. - "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. + "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. }, "dateShiftConfig": { # Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. # Config for date shift. - "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. + "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each de-identification operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. }, "infoTypes": [ # InfoTypes to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for any info_type that is not specified in another transformation. "A String", @@ -408,7 +408,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html index 732ab80a03f..bef1511c991 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html @@ -323,7 +323,7 @@

Method Details

"fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied. { # Specifies FHIR paths to match, and how to handle de-identification of matching fields. "action": "A String", # Deidentify action for one field. - "paths": [ # List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. The sub-type for HumanName, such as HumanName.given or HumanName.family, can be omitted. + "paths": [ # List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted. "A String", ], }, @@ -339,10 +339,10 @@

Method Details

"maskingCharacter": "A String", # Character to mask the sensitive values. If not supplied, defaults to "*". }, "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`. # Config for crypto hash. - "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. + "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. }, "dateShiftConfig": { # Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. # Config for date shift. - "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. + "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each de-identification operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. }, "infoTypes": [ # InfoTypes to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for any info_type that is not specified in another transformation. "A String", @@ -537,7 +537,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html index 76899e86fd7..a058d8000dc 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html @@ -206,7 +206,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. } @@ -296,7 +296,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }
@@ -458,7 +458,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }
@@ -470,7 +470,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -651,7 +651,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }, @@ -759,7 +759,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. } @@ -849,7 +849,7 @@

Method Details

"unexpectedSegmentHandling": "A String", # Determines how unexpected segments (segments not matched to the schema) are handled. }, "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. - "version": "A String", # Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation. + "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. }
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html index b86cdcd10ab..fe0fb7465a9 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html @@ -221,7 +221,7 @@

Method Details

"fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied. { # Specifies FHIR paths to match, and how to handle de-identification of matching fields. "action": "A String", # Deidentify action for one field. - "paths": [ # List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. The sub-type for HumanName, such as HumanName.given or HumanName.family, can be omitted. + "paths": [ # List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted. "A String", ], }, @@ -237,10 +237,10 @@

Method Details

"maskingCharacter": "A String", # Character to mask the sensitive values. If not supplied, defaults to "*". }, "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`. # Config for crypto hash. - "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. + "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. }, "dateShiftConfig": { # Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. # Config for date shift. - "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified. + "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each de-identification operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. }, "infoTypes": [ # InfoTypes to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for any info_type that is not specified in another transformation. "A String", @@ -329,7 +329,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html index 23c1969a7bb..19d849f7738 100644 --- a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html +++ b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html @@ -105,7 +105,7 @@

Method Details

The object takes the form of: { - "delegates": [ # The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + "delegates": [ # The sequence of service accounts in a delegation chain. This field is required for [delegated requests](https://cloud.google.com/iam/help/credentials/delegated-request). For [direct requests](https://cloud.google.com/iam/help/credentials/direct-request), which are more common, do not specify this field. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. "A String", ], "lifetime": "A String", # The desired lifetime duration of the access token in seconds. By default, the maximum allowed value is 1 hour. To set a lifetime of up to 12 hours, you can add the service account as an allowed value in an Organization Policy that enforces the `constraints/iam.allowServiceAccountCredentialLifetimeExtension` constraint. See detailed instructions at https://cloud.google.com/iam/help/credentials/lifetime If a value is not specified, the token's lifetime will be set to a default value of 1 hour. diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 3c97a732b37..f5a1311c7f7 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -587,6 +587,10 @@ * [v3](http://googleapis.github.io/google-api-python-client/docs/dyn/identitytoolkit_v3.html) +## ids +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/ids_v1.html) + + ## indexing * [v3](http://googleapis.github.io/google-api-python-client/docs/dyn/indexing_v3.html) @@ -680,6 +684,10 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/mybusinessplaceactions_v1.html) +## mybusinessqanda +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/mybusinessqanda_v1.html) + + ## mybusinessverifications * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/mybusinessverifications_v1.html) @@ -975,6 +983,7 @@ ## transcoder +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/transcoder_v1.html) * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/transcoder_v1beta1.html) diff --git a/docs/dyn/logging_v2.billingAccounts.buckets.html b/docs/dyn/logging_v2.billingAccounts.buckets.html index 367338fd0b8..fe94f16c385 100644 --- a/docs/dyn/logging_v2.billingAccounts.buckets.html +++ b/docs/dyn/logging_v2.billingAccounts.buckets.html @@ -109,7 +109,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. diff --git a/docs/dyn/logging_v2.billingAccounts.html b/docs/dyn/logging_v2.billingAccounts.html index c2bee3b6202..6daf627815d 100644 --- a/docs/dyn/logging_v2.billingAccounts.html +++ b/docs/dyn/logging_v2.billingAccounts.html @@ -109,7 +109,7 @@

Instance Methods

Close httplib2 connections.

getCmekSettings(name, x__xgafv=None)

-

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

+

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

Method Details

close() @@ -118,7 +118,7 @@

Method Details

getCmekSettings(name, x__xgafv=None) -
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+  
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
 
 Args:
   name: string, Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. (required)
@@ -133,7 +133,7 @@ 

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }
diff --git a/docs/dyn/logging_v2.billingAccounts.locations.buckets.html b/docs/dyn/logging_v2.billingAccounts.locations.buckets.html index 1476fe03e7d..ecbce1a48bb 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.buckets.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.buckets.html @@ -119,7 +119,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -146,7 +146,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -201,7 +201,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -246,7 +246,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -273,7 +273,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. diff --git a/docs/dyn/logging_v2.folders.html b/docs/dyn/logging_v2.folders.html index 2e1cb1d2696..e947a09ed75 100644 --- a/docs/dyn/logging_v2.folders.html +++ b/docs/dyn/logging_v2.folders.html @@ -99,7 +99,7 @@

Instance Methods

Close httplib2 connections.

getCmekSettings(name, x__xgafv=None)

-

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

+

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

Method Details

close() @@ -108,7 +108,7 @@

Method Details

getCmekSettings(name, x__xgafv=None) -
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+  
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
 
 Args:
   name: string, Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. (required)
@@ -123,7 +123,7 @@ 

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }
diff --git a/docs/dyn/logging_v2.folders.locations.buckets.html b/docs/dyn/logging_v2.folders.locations.buckets.html index 32c794e568e..531e72943a1 100644 --- a/docs/dyn/logging_v2.folders.locations.buckets.html +++ b/docs/dyn/logging_v2.folders.locations.buckets.html @@ -122,7 +122,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -149,7 +149,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -200,7 +200,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -237,7 +237,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -282,7 +282,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -309,7 +309,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. diff --git a/docs/dyn/logging_v2.locations.buckets.html b/docs/dyn/logging_v2.locations.buckets.html index bc7b8e5de3c..494d66d1e51 100644 --- a/docs/dyn/logging_v2.locations.buckets.html +++ b/docs/dyn/logging_v2.locations.buckets.html @@ -122,7 +122,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -149,7 +149,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -200,7 +200,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -237,7 +237,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -282,7 +282,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -309,7 +309,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. diff --git a/docs/dyn/logging_v2.organizations.html b/docs/dyn/logging_v2.organizations.html index 55f8469c552..9e1c7a14ec1 100644 --- a/docs/dyn/logging_v2.organizations.html +++ b/docs/dyn/logging_v2.organizations.html @@ -99,7 +99,7 @@

Instance Methods

Close httplib2 connections.

getCmekSettings(name, x__xgafv=None)

-

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

+

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

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

Updates the Log Router CMEK settings for the given resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

@@ -111,7 +111,7 @@

Method Details

getCmekSettings(name, x__xgafv=None) -
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+  
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
 
 Args:
   name: string, Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. (required)
@@ -126,7 +126,7 @@ 

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }
@@ -142,7 +142,7 @@

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. } updateMask: string, Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" @@ -157,7 +157,7 @@

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }
diff --git a/docs/dyn/logging_v2.organizations.locations.buckets.html b/docs/dyn/logging_v2.organizations.locations.buckets.html index 9e43c601dc3..21a31391f20 100644 --- a/docs/dyn/logging_v2.organizations.locations.buckets.html +++ b/docs/dyn/logging_v2.organizations.locations.buckets.html @@ -122,7 +122,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -149,7 +149,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -200,7 +200,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -237,7 +237,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -282,7 +282,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -309,7 +309,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. diff --git a/docs/dyn/logging_v2.projects.html b/docs/dyn/logging_v2.projects.html index 28d874f5d82..bb24fcee2ad 100644 --- a/docs/dyn/logging_v2.projects.html +++ b/docs/dyn/logging_v2.projects.html @@ -104,7 +104,7 @@

Instance Methods

Close httplib2 connections.

getCmekSettings(name, x__xgafv=None)

-

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

+

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

Method Details

close() @@ -113,7 +113,7 @@

Method Details

getCmekSettings(name, x__xgafv=None) -
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+  
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
 
 Args:
   name: string, Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. (required)
@@ -128,7 +128,7 @@ 

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }
diff --git a/docs/dyn/logging_v2.projects.locations.buckets.html b/docs/dyn/logging_v2.projects.locations.buckets.html index 3c5b78d6523..42046b65b1d 100644 --- a/docs/dyn/logging_v2.projects.locations.buckets.html +++ b/docs/dyn/logging_v2.projects.locations.buckets.html @@ -122,7 +122,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -149,7 +149,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -200,7 +200,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -237,7 +237,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -282,7 +282,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. @@ -309,7 +309,7 @@

Method Details

"cmekSettings": { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. # The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }, "createTime": "A String", # Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. "description": "A String", # Describes this bucket. diff --git a/docs/dyn/logging_v2.v2.html b/docs/dyn/logging_v2.v2.html index 2b9eec62bbf..a5dde55a264 100644 --- a/docs/dyn/logging_v2.v2.html +++ b/docs/dyn/logging_v2.v2.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

getCmekSettings(name, x__xgafv=None)

-

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

+

Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

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

Updates the Log Router CMEK settings for the given resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

@@ -91,7 +91,7 @@

Method Details

getCmekSettings(name, x__xgafv=None) -
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+  
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
 
 Args:
   name: string, Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. (required)
@@ -106,7 +106,7 @@ 

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }
@@ -122,7 +122,7 @@

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. } updateMask: string, Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" @@ -137,7 +137,7 @@

Method Details

{ # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "kmsKeyName": "A String", # The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. "name": "A String", # Output only. The resource name of the CMEK settings. - "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + "serviceAccountId": "A String", # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. }
diff --git a/docs/dyn/monitoring_v3.folders.timeSeries.html b/docs/dyn/monitoring_v3.folders.timeSeries.html index ee8d7142029..30c3ef2c56b 100644 --- a/docs/dyn/monitoring_v3.folders.timeSeries.html +++ b/docs/dyn/monitoring_v3.folders.timeSeries.html @@ -223,7 +223,7 @@

Method Details

"metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. { # A single data point in a time series. - "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. + "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. "endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, diff --git a/docs/dyn/monitoring_v3.organizations.timeSeries.html b/docs/dyn/monitoring_v3.organizations.timeSeries.html index bdfadac4e53..a6908740d31 100644 --- a/docs/dyn/monitoring_v3.organizations.timeSeries.html +++ b/docs/dyn/monitoring_v3.organizations.timeSeries.html @@ -223,7 +223,7 @@

Method Details

"metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. { # A single data point in a time series. - "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. + "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. "endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, diff --git a/docs/dyn/monitoring_v3.projects.timeSeries.html b/docs/dyn/monitoring_v3.projects.timeSeries.html index cd7016d6386..080b3a11b16 100644 --- a/docs/dyn/monitoring_v3.projects.timeSeries.html +++ b/docs/dyn/monitoring_v3.projects.timeSeries.html @@ -130,7 +130,7 @@

Method Details

"metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. { # A single data point in a time series. - "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. + "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. "endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, @@ -235,7 +235,7 @@

Method Details

"metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. { # A single data point in a time series. - "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. + "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. "endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, @@ -445,7 +445,7 @@

Method Details

"metricKind": "A String", # The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. "points": [ # The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. { # A single data point in a time series. - "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. + "interval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. "endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, @@ -572,7 +572,7 @@

Method Details

], "pointData": [ # The points in the time series. { # A point's value columns and time interval. Each point has one or more point values corresponding to the entries in point_descriptors field in the TimeSeriesDescriptor associated with this object. - "timeInterval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval associated with the point. + "timeInterval": { # Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. # The time interval associated with the point. "endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, diff --git a/docs/dyn/monitoring_v3.projects.uptimeCheckConfigs.html b/docs/dyn/monitoring_v3.projects.uptimeCheckConfigs.html index 59507ad4cbb..f3b714f4e9d 100644 --- a/docs/dyn/monitoring_v3.projects.uptimeCheckConfigs.html +++ b/docs/dyn/monitoring_v3.projects.uptimeCheckConfigs.html @@ -123,7 +123,7 @@

Method Details

"password": "A String", # The password to use when authenticating with the HTTP server. "username": "A String", # The username to use when authenticating with the HTTP server. }, - "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". + "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type. "contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead. "headers": { # The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. "a_key": "A String", @@ -188,7 +188,7 @@

Method Details

"password": "A String", # The password to use when authenticating with the HTTP server. "username": "A String", # The username to use when authenticating with the HTTP server. }, - "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". + "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type. "contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead. "headers": { # The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. "a_key": "A String", @@ -278,7 +278,7 @@

Method Details

"password": "A String", # The password to use when authenticating with the HTTP server. "username": "A String", # The username to use when authenticating with the HTTP server. }, - "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". + "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type. "contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead. "headers": { # The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. "a_key": "A String", @@ -356,7 +356,7 @@

Method Details

"password": "A String", # The password to use when authenticating with the HTTP server. "username": "A String", # The username to use when authenticating with the HTTP server. }, - "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". + "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type. "contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead. "headers": { # The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. "a_key": "A String", @@ -439,7 +439,7 @@

Method Details

"password": "A String", # The password to use when authenticating with the HTTP server. "username": "A String", # The username to use when authenticating with the HTTP server. }, - "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". + "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type. "contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead. "headers": { # The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. "a_key": "A String", @@ -505,7 +505,7 @@

Method Details

"password": "A String", # The password to use when authenticating with the HTTP server. "username": "A String", # The username to use when authenticating with the HTTP server. }, - "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". + "body": "A String", # The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type. "contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead. "headers": { # The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. "a_key": "A String", diff --git a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html index eae9d325a21..6a214f1c3ce 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html @@ -147,7 +147,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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]. }, @@ -381,7 +381,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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]. }, @@ -627,7 +627,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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/mybusinessbusinessinformation_v1.googleLocations.html b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html index b060302d5f5..efac5fdd8d3 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html @@ -141,7 +141,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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]. }, @@ -379,7 +379,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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/mybusinessbusinessinformation_v1.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.locations.html index fe41ffda718..93e3e2195bd 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.locations.html @@ -90,7 +90,7 @@

Instance Methods

Close httplib2 connections.

delete(name, x__xgafv=None)

-

Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google My Business](https://business.google.com/manage/) website.

+

Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google Business Profile](https://business.google.com/manage/) website.

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

Returns the specified location.

@@ -163,7 +163,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google My Business](https://business.google.com/manage/) website.
+  
Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google Business Profile](https://business.google.com/manage/) website.
 
 Args:
   name: string, Required. The name of the location to delete. (required)
@@ -240,7 +240,7 @@ 

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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]. }, @@ -523,7 +523,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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]. }, @@ -759,7 +759,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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]. }, @@ -993,7 +993,7 @@

Method Details

"A String", ], "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable. - "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients. + "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. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients. "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/mybusinessqanda_v1.html b/docs/dyn/mybusinessqanda_v1.html new file mode 100644 index 00000000000..375e08965ad --- /dev/null +++ b/docs/dyn/mybusinessqanda_v1.html @@ -0,0 +1,111 @@ + + + +

My Business Q&A API

+

Instance Methods

+

+ locations() +

+

Returns the locations 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/mybusinessqanda_v1.locations.html b/docs/dyn/mybusinessqanda_v1.locations.html new file mode 100644 index 00000000000..d179f892754 --- /dev/null +++ b/docs/dyn/mybusinessqanda_v1.locations.html @@ -0,0 +1,91 @@ + + + +

My Business Q&A API . locations

+

Instance Methods

+

+ questions() +

+

Returns the questions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/mybusinessqanda_v1.locations.questions.answers.html b/docs/dyn/mybusinessqanda_v1.locations.questions.answers.html new file mode 100644 index 00000000000..9ec0c463f85 --- /dev/null +++ b/docs/dyn/mybusinessqanda_v1.locations.questions.answers.html @@ -0,0 +1,192 @@ + + + +

My Business Q&A API . locations . questions . answers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Returns the paginated list of answers for a specified question.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the paginated list of answers for a specified question.
+
+Args:
+  parent: string, Required. The name of the question to fetch answers for. (required)
+  orderBy: string, Optional. The order to return the answers. Valid options include 'update_time desc' and 'upvote_count desc', which will return the answers sorted descendingly by the requested field. The default sort order is 'update_time desc'.
+  pageSize: integer, Optional. How many answers to fetch per page. The default and maximum `page_size` values are 10.
+  pageToken: string, Optional. If specified, the next page of answers is retrieved.
+  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 QuestionsAndAnswers.ListAnswers
+  "answers": [ # The requested answers.
+    { # Represents an answer to a question
+      "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+        "displayName": "A String", # The display name of the user
+        "profilePhotoUri": "A String", # The profile photo URI of the user.
+        "type": "A String", # The type of user the author is.
+      },
+      "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+      "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+      "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+      "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+      "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+    },
+  ],
+  "nextPageToken": "A String", # If the number of answers exceeds the requested max page size, this field is populated with a token to fetch the next page of answers on a subsequent call. If there are no more answers, this field is not present in the response.
+  "totalSize": 42, # The total number of answers posted for this question across all pages.
+}
+
+ +
+ 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.
+    
+
+ +
+ upsert(parent, body=None, x__xgafv=None) +
Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.
+
+Args:
+  parent: string, Required. The name of the question to write an answer for. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for QuestionsAndAnswers.UpsertAnswer
+  "answer": { # Represents an answer to a question # Required. The new answer.
+    "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+      "displayName": "A String", # The display name of the user
+      "profilePhotoUri": "A String", # The profile photo URI of the user.
+      "type": "A String", # The type of user the author is.
+    },
+    "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+    "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+    "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+    "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+    "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an answer to a question
+  "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+    "displayName": "A String", # The display name of the user
+    "profilePhotoUri": "A String", # The profile photo URI of the user.
+    "type": "A String", # The type of user the author is.
+  },
+  "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+  "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+  "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+  "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+  "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/mybusinessqanda_v1.locations.questions.html b/docs/dyn/mybusinessqanda_v1.locations.questions.html new file mode 100644 index 00000000000..c16df032dbc --- /dev/null +++ b/docs/dyn/mybusinessqanda_v1.locations.questions.html @@ -0,0 +1,362 @@ + + + +

My Business Q&A API . locations . questions

+

Instance Methods

+

+ answers() +

+

Returns the answers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Adds a question for the specified location.

+

+ delete(name, x__xgafv=None)

+

Deletes a specific question written by the current user.

+

+ deleteAnswers(name, x__xgafv=None)

+

Deletes the answer written by the current user to a question.

+

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

+

Returns the paginated list of questions and some of its answers for a specified location. This operation is only valid if the specified location is verified.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates a specific question written by the current user.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Adds a question for the specified location.
+
+Args:
+  parent: string, Required. The name of the location to write a question for. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a single question and some of its answers.
+  "author": { # Represents the author of a question or answer # Output only. The author of the question.
+    "displayName": "A String", # The display name of the user
+    "profilePhotoUri": "A String", # The profile photo URI of the user.
+    "type": "A String", # The type of user the author is.
+  },
+  "createTime": "A String", # Output only. The timestamp for when the question was written.
+  "name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
+  "text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
+  "topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
+    { # Represents an answer to a question
+      "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+        "displayName": "A String", # The display name of the user
+        "profilePhotoUri": "A String", # The profile photo URI of the user.
+        "type": "A String", # The type of user the author is.
+      },
+      "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+      "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+      "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+      "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+      "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+    },
+  ],
+  "totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
+  "updateTime": "A String", # Output only. The timestamp for when the question was last modified.
+  "upvoteCount": 42, # Output only. The number of upvotes for the question.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single question and some of its answers.
+  "author": { # Represents the author of a question or answer # Output only. The author of the question.
+    "displayName": "A String", # The display name of the user
+    "profilePhotoUri": "A String", # The profile photo URI of the user.
+    "type": "A String", # The type of user the author is.
+  },
+  "createTime": "A String", # Output only. The timestamp for when the question was written.
+  "name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
+  "text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
+  "topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
+    { # Represents an answer to a question
+      "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+        "displayName": "A String", # The display name of the user
+        "profilePhotoUri": "A String", # The profile photo URI of the user.
+        "type": "A String", # The type of user the author is.
+      },
+      "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+      "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+      "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+      "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+      "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+    },
+  ],
+  "totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
+  "updateTime": "A String", # Output only. The timestamp for when the question was last modified.
+  "upvoteCount": 42, # Output only. The number of upvotes for the question.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a specific question written by the current user.
+
+Args:
+  name: string, Required. The name of the question to delete. (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 `{}`.
+}
+
+ +
+ deleteAnswers(name, x__xgafv=None) +
Deletes the answer written by the current user to a question.
+
+Args:
+  name: string, Required. The name of the question to delete an answer for. (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 `{}`.
+}
+
+ +
+ list(parent, answersPerQuestion=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the paginated list of questions and some of its answers for a specified location. This operation is only valid if the specified location is verified.
+
+Args:
+  parent: string, Required. The name of the location to fetch questions for. (required)
+  answersPerQuestion: integer, Optional. How many answers to fetch per question. The default and maximum `answers_per_question` values are 10.
+  filter: string, Optional. A filter constraining the questions to return. The only filter currently supported is "ignore_answered=true"
+  orderBy: string, Optional. The order to return the questions. Valid options include 'update_time desc' and 'upvote_count desc', which will return the questions sorted descendingly by the requested field. The default sort order is 'update_time desc'.
+  pageSize: integer, Optional. How many questions to fetch per page. The default and maximum `page_size` values are 10.
+  pageToken: string, Optional. If specified, the next page of questions is retrieved.
+  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 QuestionsAndAnswers.ListQuestions
+  "nextPageToken": "A String", # If the number of questions exceeds the requested max page size, this field is populated with a token to fetch the next page of questions on a subsequent call. If there are no more questions, this field is not present in the response.
+  "questions": [ # The requested questions,
+    { # Represents a single question and some of its answers.
+      "author": { # Represents the author of a question or answer # Output only. The author of the question.
+        "displayName": "A String", # The display name of the user
+        "profilePhotoUri": "A String", # The profile photo URI of the user.
+        "type": "A String", # The type of user the author is.
+      },
+      "createTime": "A String", # Output only. The timestamp for when the question was written.
+      "name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
+      "text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
+      "topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
+        { # Represents an answer to a question
+          "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+            "displayName": "A String", # The display name of the user
+            "profilePhotoUri": "A String", # The profile photo URI of the user.
+            "type": "A String", # The type of user the author is.
+          },
+          "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+          "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+          "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+          "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+          "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+        },
+      ],
+      "totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
+      "updateTime": "A String", # Output only. The timestamp for when the question was last modified.
+      "upvoteCount": 42, # Output only. The number of upvotes for the question.
+    },
+  ],
+  "totalSize": 42, # The total number of questions posted for this location across all pages.
+}
+
+ +
+ 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 specific question written by the current user.
+
+Args:
+  name: string, Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a single question and some of its answers.
+  "author": { # Represents the author of a question or answer # Output only. The author of the question.
+    "displayName": "A String", # The display name of the user
+    "profilePhotoUri": "A String", # The profile photo URI of the user.
+    "type": "A String", # The type of user the author is.
+  },
+  "createTime": "A String", # Output only. The timestamp for when the question was written.
+  "name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
+  "text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
+  "topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
+    { # Represents an answer to a question
+      "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+        "displayName": "A String", # The display name of the user
+        "profilePhotoUri": "A String", # The profile photo URI of the user.
+        "type": "A String", # The type of user the author is.
+      },
+      "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+      "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+      "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+      "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+      "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+    },
+  ],
+  "totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
+  "updateTime": "A String", # Output only. The timestamp for when the question was last modified.
+  "upvoteCount": 42, # Output only. The number of upvotes for the question.
+}
+
+  updateMask: string, Required. The specific fields to update. Only question text can be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single question and some of its answers.
+  "author": { # Represents the author of a question or answer # Output only. The author of the question.
+    "displayName": "A String", # The display name of the user
+    "profilePhotoUri": "A String", # The profile photo URI of the user.
+    "type": "A String", # The type of user the author is.
+  },
+  "createTime": "A String", # Output only. The timestamp for when the question was written.
+  "name": "A String", # Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.
+  "text": "A String", # Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.
+  "topAnswers": [ # Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)
+    { # Represents an answer to a question
+      "author": { # Represents the author of a question or answer # Output only. The author of the answer. Will only be set during list operations.
+        "displayName": "A String", # The display name of the user
+        "profilePhotoUri": "A String", # The profile photo URI of the user.
+        "type": "A String", # The type of user the author is.
+      },
+      "createTime": "A String", # Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.
+      "name": "A String", # Output only. The unique name for the answer locations/*/questions/*/answers/*
+      "text": "A String", # Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.
+      "updateTime": "A String", # Output only. The timestamp for when the answer was last modified.
+      "upvoteCount": 42, # Output only. The number of upvotes for the answer.
+    },
+  ],
+  "totalAnswerCount": 42, # Output only. The total number of answers posted for this question.
+  "updateTime": "A String", # Output only. The timestamp for when the question was last modified.
+  "upvoteCount": 42, # Output only. The number of upvotes for the question.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html index 47b49fad5ec..4529d0b3f77 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html @@ -128,6 +128,7 @@

Method Details

"name": "A String", # Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}` "routingVpcs": [ # The VPC network associated with this hub's spokes. All of the VPN tunnels, VLAN attachments, and router appliance instances referenced by this hub's spokes must belong to this VPC network. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. { # RoutingVPC contains information about the VPC network that is associated with a hub's spokes. + "requiredForNewSiteToSiteDataTransferSpokes": True or False, # Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. "uri": "A String", # The URI of the VPC network. }, ], @@ -226,6 +227,7 @@

Method Details

"name": "A String", # Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}` "routingVpcs": [ # The VPC network associated with this hub's spokes. All of the VPN tunnels, VLAN attachments, and router appliance instances referenced by this hub's spokes must belong to this VPC network. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. { # RoutingVPC contains information about the VPC network that is associated with a hub's spokes. + "requiredForNewSiteToSiteDataTransferSpokes": True or False, # Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. "uri": "A String", # The URI of the VPC network. }, ], @@ -312,6 +314,7 @@

Method Details

"name": "A String", # Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}` "routingVpcs": [ # The VPC network associated with this hub's spokes. All of the VPN tunnels, VLAN attachments, and router appliance instances referenced by this hub's spokes must belong to this VPC network. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. { # RoutingVPC contains information about the VPC network that is associated with a hub's spokes. + "requiredForNewSiteToSiteDataTransferSpokes": True or False, # Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. "uri": "A String", # The URI of the VPC network. }, ], @@ -359,6 +362,7 @@

Method Details

"name": "A String", # Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}` "routingVpcs": [ # The VPC network associated with this hub's spokes. All of the VPN tunnels, VLAN attachments, and router appliance instances referenced by this hub's spokes must belong to this VPC network. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. { # RoutingVPC contains information about the VPC network that is associated with a hub's spokes. + "requiredForNewSiteToSiteDataTransferSpokes": True or False, # Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. "uri": "A String", # The URI of the VPC network. }, ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.html b/docs/dyn/networkservices_v1beta1.projects.locations.html index 93086a64a71..301d011fd1d 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the operations Resource.

+

+ serviceBindings() +

+

Returns the serviceBindings Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html b/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html new file mode 100644 index 00000000000..98cda9f0061 --- /dev/null +++ b/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html @@ -0,0 +1,258 @@ + + + +

Network Services API . projects . locations . serviceBindings

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

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

+

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

+

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

+

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

+

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.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # 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.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # 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.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # 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.
+      },
+      "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `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.
+  "version": 42, # 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).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # 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.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # 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.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # 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.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # 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.
+        },
+        "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+      },
+    ],
+    "etag": "A String", # `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.
+    "version": 42, # 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).
+  },
+  "updateMask": "A String", # 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"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # 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.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # 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.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # 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.
+      },
+      "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `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.
+  "version": 42, # 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).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # 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).
+    "A String",
+  ],
+}
+
+  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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html index 2b3a2988a81..abecfdd9500 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html @@ -579,6 +579,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html index ccd0f77712a..b12997b277c 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html @@ -579,6 +579,20 @@

Method Details

}, "vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score. # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", + "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + "authentication": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, # The base score is a function of the base metric scores. + "confidentialityImpact": "A String", + "exploitabilityScore": 3.14, + "impactScore": 3.14, + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available. "longDescription": "A String", # Output only. A detailed description of this vulnerability. diff --git a/docs/dyn/osconfig_v1.projects.patchDeployments.html b/docs/dyn/osconfig_v1.projects.patchDeployments.html index 16c4133a14b..b30419525e7 100644 --- a/docs/dyn/osconfig_v1.projects.patchDeployments.html +++ b/docs/dyn/osconfig_v1.projects.patchDeployments.html @@ -95,6 +95,12 @@

Instance Methods

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

Update an OS Config patch deployment.

+

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

+

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

+

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

+

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Method Details

close() @@ -276,6 +282,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. } @@ -454,6 +461,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. }
@@ -656,6 +664,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. }
@@ -845,6 +854,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. }, ], @@ -1040,6 +1050,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. } @@ -1218,6 +1229,389 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. + "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +}
+
+ +
+ pause(name, body=None, x__xgafv=None) +
Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.
+
+Args:
+  name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for pausing a patch deployment.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).
+  "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+  "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+  "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch.
+    "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+    "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.
+      { # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.
+        "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
+      "A String",
+    ],
+    "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+      "A String",
+    ],
+    "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
+      "A String",
+    ],
+  },
+  "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment.
+  "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution.
+    "executeTime": "A String", # Required. The desired patch job execution time.
+  },
+  "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
+    "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages will be excluded
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+    },
+    "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+    },
+    "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "rebootConfig": "A String", # Post-patch reboot settings.
+    "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+      "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+        "A String",
+      ],
+      "excludes": [ # List of KBs to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+        "A String",
+      ],
+    },
+    "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+      "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+    },
+    "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+      "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+        "A String",
+      ],
+      "excludes": [ # List of patches to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+        "A String",
+      ],
+      "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+        "A String",
+      ],
+      "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+      "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+    },
+  },
+  "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
+    "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+    "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+    "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
+    "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions.
+      "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc.
+      "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+        "dayOfWeek": "A String", # Required. A day of the week.
+        "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30].
+        "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month.
+      },
+    },
+    "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+    "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
+    "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment.
+      "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+      "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+      "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+    },
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone.
+      "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".
+    },
+    "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
+      "dayOfWeek": "A String", # Required. Day of the week.
+    },
+  },
+  "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job.
+    "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+      "fixed": 42, # Specifies a fixed value.
+      "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+    },
+    "mode": "A String", # Mode of the patch rollout.
+  },
+  "state": "A String", # Output only. Current state of the patch deployment.
+  "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+}
+
+ +
+ resume(name, body=None, x__xgafv=None) +
Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.
+
+Args:
+  name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for resuming a patch deployment.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).
+  "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+  "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+  "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch.
+    "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+    "groupLabels": [ # Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.
+      { # Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.
+        "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
+      "A String",
+    ],
+    "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+      "A String",
+    ],
+    "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
+      "A String",
+    ],
+  },
+  "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment.
+  "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution.
+    "executeTime": "A String", # Required. The desired patch job execution time.
+  },
+  "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
+    "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages will be excluded
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+    },
+    "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+    },
+    "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Cloud Storage object representation. # A Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "rebootConfig": "A String", # Post-patch reboot settings.
+    "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+      "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+        "A String",
+      ],
+      "excludes": [ # List of KBs to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+        "A String",
+      ],
+    },
+    "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+      "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+    },
+    "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+      "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+        "A String",
+      ],
+      "excludes": [ # List of patches to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+        "A String",
+      ],
+      "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+        "A String",
+      ],
+      "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+      "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+    },
+  },
+  "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
+    "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+    "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+    "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
+    "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions.
+      "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc.
+      "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+        "dayOfWeek": "A String", # Required. A day of the week.
+        "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30].
+        "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month.
+      },
+    },
+    "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+    "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
+    "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment.
+      "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+      "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+      "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+    },
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone.
+      "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".
+    },
+    "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
+      "dayOfWeek": "A String", # Required. Day of the week.
+    },
+  },
+  "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job.
+    "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+      "fixed": 42, # Specifies a fixed value.
+      "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+    },
+    "mode": "A String", # Mode of the patch rollout.
+  },
+  "state": "A String", # Output only. Current state of the patch deployment.
   "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
 }
diff --git a/docs/dyn/osconfig_v1beta.projects.patchDeployments.html b/docs/dyn/osconfig_v1beta.projects.patchDeployments.html index 69e724a6345..b70fd618316 100644 --- a/docs/dyn/osconfig_v1beta.projects.patchDeployments.html +++ b/docs/dyn/osconfig_v1beta.projects.patchDeployments.html @@ -95,6 +95,12 @@

Instance Methods

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

Update an OS Config patch deployment.

+

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

+

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

+

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

+

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Method Details

close() @@ -276,6 +282,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. } @@ -454,6 +461,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. }
@@ -656,6 +664,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. }
@@ -845,6 +854,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. }, ], @@ -1040,6 +1050,7 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. } @@ -1218,6 +1229,389 @@

Method Details

}, "mode": "A String", # Mode of the patch rollout. }, + "state": "A String", # Output only. Current state of the patch deployment. + "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +}
+
+ +
+ pause(name, body=None, x__xgafv=None) +
Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.
+
+Args:
+  name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for pausing a patch deployment.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).
+  "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+  "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+  "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch.
+    "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+    "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".
+      { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".
+        "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
+      "A String",
+    ],
+    "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+      "A String",
+    ],
+    "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
+      "A String",
+    ],
+  },
+  "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment.
+  "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution.
+    "executeTime": "A String", # Required. The desired patch job execution time.
+  },
+  "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
+    "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages will be excluded
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+    },
+    "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+    },
+    "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "rebootConfig": "A String", # Post-patch reboot settings.
+    "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+      "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+        "A String",
+      ],
+      "excludes": [ # List of KBs to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+        "A String",
+      ],
+    },
+    "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+      "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+    },
+    "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+      "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+        "A String",
+      ],
+      "excludes": [ # List of patches to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+        "A String",
+      ],
+      "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+        "A String",
+      ],
+      "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+      "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+    },
+  },
+  "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
+    "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+    "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+    "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
+    "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions.
+      "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc.
+      "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+        "dayOfWeek": "A String", # Required. A day of the week.
+        "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30].
+        "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month.
+      },
+    },
+    "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+    "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
+    "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment.
+      "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+      "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+      "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+    },
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone.
+      "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".
+    },
+    "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
+      "dayOfWeek": "A String", # Required. Day of the week.
+    },
+  },
+  "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job.
+    "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+      "fixed": 42, # Specifies a fixed value.
+      "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+    },
+    "mode": "A String", # Mode of the patch rollout.
+  },
+  "state": "A String", # Output only. Current state of the patch deployment.
+  "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+}
+
+ +
+ resume(name, body=None, x__xgafv=None) +
Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.
+
+Args:
+  name: string, Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for resuming a patch deployment.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).
+  "createTime": "A String", # Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "description": "A String", # Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
+  "duration": "A String", # Optional. Duration of the patch. After the duration ends, the patch times out.
+  "instanceFilter": { # A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. # Required. VM instances to patch.
+    "all": True or False, # Target all VM instances in the project. If true, no other criteria is permitted.
+    "groupLabels": [ # Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".
+      { # Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".
+        "labels": { # Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
+          "a_key": "A String",
+        },
+      },
+    ],
+    "instanceNamePrefixes": [ # Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
+      "A String",
+    ],
+    "instances": [ # Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
+      "A String",
+    ],
+    "zones": [ # Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
+      "A String",
+    ],
+  },
+  "lastExecuteTime": "A String", # Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "name": "A String", # Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment.
+  "oneTimeSchedule": { # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Required. Schedule a one-time execution.
+    "executeTime": "A String", # Required. The desired patch job execution time.
+  },
+  "patchConfig": { # Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. # Optional. Patch configuration that is applied.
+    "apt": { # Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. # Apt update settings. Use this setting to override the default `apt` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages will be excluded
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "type": "A String", # By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
+    },
+    "goo": { # Googet patching is performed by running `googet update`. # Goo update settings. Use this setting to override the default `goo` patch rules.
+    },
+    "postStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run after the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "preStep": { # A step that runs an executable for a PatchJob. # The `ExecStep` to run before the patch update.
+      "linuxExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Linux VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+      "windowsExecStepConfig": { # Common configurations for an ExecStep. # The ExecStepConfig for all Windows VMs targeted by the PatchJob.
+        "allowedSuccessCodes": [ # Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
+          42,
+        ],
+        "gcsObject": { # Google Cloud Storage object representation. # A Google Cloud Storage object containing the executable.
+          "bucket": "A String", # Required. Bucket of the Google Cloud Storage object.
+          "generationNumber": "A String", # Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
+          "object": "A String", # Required. Name of the Google Cloud Storage object.
+        },
+        "interpreter": "A String", # The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
+        "localPath": "A String", # An absolute path to the executable on the VM.
+      },
+    },
+    "rebootConfig": "A String", # Post-patch reboot settings.
+    "windowsUpdate": { # Windows patching is performed using the Windows Update Agent. # Windows update settings. Use this override the default windows patch rules.
+      "classifications": [ # Only apply updates of these windows update classifications. If empty, all updates are applied.
+        "A String",
+      ],
+      "excludes": [ # List of KBs to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
+        "A String",
+      ],
+    },
+    "yum": { # Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. # Yum update settings. Use this setting to override the default `yum` patch rules.
+      "excludes": [ # List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
+        "A String",
+      ],
+      "exclusivePackages": [ # An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
+        "A String",
+      ],
+      "minimal": True or False, # Will cause patch to run `yum update-minimal` instead.
+      "security": True or False, # Adds the `--security` flag to `yum update`. Not supported on all platforms.
+    },
+    "zypper": { # Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. # Zypper update settings. Use this setting to override the default `zypper` patch rules.
+      "categories": [ # Install only patches with these categories. Common categories include security, recommended, and feature.
+        "A String",
+      ],
+      "excludes": [ # List of patches to exclude from update.
+        "A String",
+      ],
+      "exclusivePatches": [ # An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
+        "A String",
+      ],
+      "severities": [ # Install only patches with these severities. Common severities include critical, important, moderate, and low.
+        "A String",
+      ],
+      "withOptional": True or False, # Adds the `--with-optional` flag to `zypper patch`.
+      "withUpdate": True or False, # Adds the `--with-update` flag, to `zypper patch`.
+    },
+  },
+  "recurringSchedule": { # Sets the time for recurring patch deployments. # Required. Schedule recurring executions.
+    "endTime": "A String", # Optional. The end time at which a recurring patch deployment schedule is no longer active.
+    "frequency": "A String", # Required. The frequency unit of this recurring schedule.
+    "lastExecuteTime": "A String", # Output only. The time the last patch job ran successfully.
+    "monthly": { # Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". # Required. Schedule with monthly executions.
+      "monthDay": 42, # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc.
+      "weekDayOfMonth": { # Represents one week day in a month. An example is "the 4th Sunday". # Required. Week day in a month.
+        "dayOfWeek": "A String", # Required. A day of the week.
+        "dayOffset": 42, # Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week` values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30].
+        "weekOrdinal": 42, # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month.
+      },
+    },
+    "nextExecuteTime": "A String", # Output only. The time the next patch job is scheduled to run.
+    "startTime": "A String", # Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
+    "timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time of the day to run a recurring deployment.
+      "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+      "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+      "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+    },
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone.
+      "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".
+    },
+    "weekly": { # Represents a weekly schedule. # Required. Schedule with weekly executions.
+      "dayOfWeek": "A String", # Required. Day of the week.
+    },
+  },
+  "rollout": { # Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. # Optional. Rollout strategy of the patch job.
+    "disruptionBudget": { # Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. # The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
+      "fixed": 42, # Specifies a fixed value.
+      "percent": 42, # Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
+    },
+    "mode": "A String", # Mode of the patch rollout.
+  },
+  "state": "A String", # Output only. Current state of the patch deployment.
   "updateTime": "A String", # Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
 }
diff --git a/docs/dyn/oslogin_v1.users.html b/docs/dyn/oslogin_v1.users.html index 10a47610270..e82738229ee 100644 --- a/docs/dyn/oslogin_v1.users.html +++ b/docs/dyn/oslogin_v1.users.html @@ -79,11 +79,6 @@

Instance Methods

Returns the projects Resource.

-

- sshPublicKey() -

-

Returns the sshPublicKey Resource.

-

sshPublicKeys()

diff --git a/docs/dyn/oslogin_v1.users.sshPublicKeys.html b/docs/dyn/oslogin_v1.users.sshPublicKeys.html index 0965558e55e..2255973de2e 100644 --- a/docs/dyn/oslogin_v1.users.sshPublicKeys.html +++ b/docs/dyn/oslogin_v1.users.sshPublicKeys.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Create an SSH public key

delete(name, x__xgafv=None)

Deletes an SSH public key.

@@ -92,6 +95,38 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Create an SSH public key
+
+Args:
+  parent: string, Required. The unique ID for the user in format `users/{user}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SSH public key information associated with a Google account.
+  "expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
+  "fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
+  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+  "name": "A String", # Output only. The canonical resource name.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SSH public key information associated with a Google account.
+  "expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
+  "fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
+  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+  "name": "A String", # Output only. The canonical resource name.
+}
+
+
delete(name, x__xgafv=None)
Deletes an SSH public key.
diff --git a/docs/dyn/oslogin_v1alpha.users.html b/docs/dyn/oslogin_v1alpha.users.html
index b704c42cc6c..3d5d134a3d8 100644
--- a/docs/dyn/oslogin_v1alpha.users.html
+++ b/docs/dyn/oslogin_v1alpha.users.html
@@ -79,11 +79,6 @@ 

Instance Methods

Returns the projects Resource.

-

- sshPublicKey() -

-

Returns the sshPublicKey Resource.

-

sshPublicKeys()

diff --git a/docs/dyn/oslogin_v1alpha.users.sshPublicKeys.html b/docs/dyn/oslogin_v1alpha.users.sshPublicKeys.html index b8ab11a6249..6533342546f 100644 --- a/docs/dyn/oslogin_v1alpha.users.sshPublicKeys.html +++ b/docs/dyn/oslogin_v1alpha.users.sshPublicKeys.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Create an SSH public key

delete(name, x__xgafv=None)

Deletes an SSH public key.

@@ -92,6 +95,38 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Create an SSH public key
+
+Args:
+  parent: string, Required. The unique ID for the user in format `users/{user}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SSH public key information associated with a Google account.
+  "expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
+  "fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
+  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+  "name": "A String", # Output only. The canonical resource name.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SSH public key information associated with a Google account.
+  "expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
+  "fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
+  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+  "name": "A String", # Output only. The canonical resource name.
+}
+
+
delete(name, x__xgafv=None)
Deletes an SSH public key.
diff --git a/docs/dyn/oslogin_v1beta.users.html b/docs/dyn/oslogin_v1beta.users.html
index 1225335dead..b26e6edb5cd 100644
--- a/docs/dyn/oslogin_v1beta.users.html
+++ b/docs/dyn/oslogin_v1beta.users.html
@@ -79,11 +79,6 @@ 

Instance Methods

Returns the projects Resource.

-

- sshPublicKey() -

-

Returns the sshPublicKey Resource.

-

sshPublicKeys()

diff --git a/docs/dyn/oslogin_v1beta.users.sshPublicKeys.html b/docs/dyn/oslogin_v1beta.users.sshPublicKeys.html index c53dae38591..877d0e3c9c0 100644 --- a/docs/dyn/oslogin_v1beta.users.sshPublicKeys.html +++ b/docs/dyn/oslogin_v1beta.users.sshPublicKeys.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Create an SSH public key

delete(name, x__xgafv=None)

Deletes an SSH public key.

@@ -92,6 +95,38 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Create an SSH public key
+
+Args:
+  parent: string, Required. The unique ID for the user in format `users/{user}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SSH public key information associated with a Google account.
+  "expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
+  "fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
+  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+  "name": "A String", # Output only. The canonical resource name.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SSH public key information associated with a Google account.
+  "expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
+  "fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
+  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+  "name": "A String", # Output only. The canonical resource name.
+}
+
+
delete(name, x__xgafv=None)
Deletes an SSH public key.
diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html
index 67461b4b7f9..08a3edefbb5 100644
--- a/docs/dyn/pubsub_v1.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1.projects.subscriptions.html
@@ -181,7 +181,7 @@ 

Method Details

}, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. At most one of `pushConfig` and `bigQueryConfig` can be set. If both are empty, then the subscriber will pull and ack messages using API methods. "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } "a_key": "A String", }, @@ -196,6 +196,7 @@

Method Details

"maximumBackoff": "A String", # The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, + "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. } @@ -225,7 +226,7 @@

Method Details

}, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. At most one of `pushConfig` and `bigQueryConfig` can be set. If both are empty, then the subscriber will pull and ack messages using API methods. "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } "a_key": "A String", }, @@ -240,6 +241,7 @@

Method Details

"maximumBackoff": "A String", # The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, + "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. }
@@ -312,7 +314,7 @@

Method Details

}, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. At most one of `pushConfig` and `bigQueryConfig` can be set. If both are empty, then the subscriber will pull and ack messages using API methods. "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } "a_key": "A String", }, @@ -327,6 +329,7 @@

Method Details

"maximumBackoff": "A String", # The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, + "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. }
@@ -403,7 +406,7 @@

Method Details

}, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. At most one of `pushConfig` and `bigQueryConfig` can be set. If both are empty, then the subscriber will pull and ack messages using API methods. "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } "a_key": "A String", }, @@ -418,6 +421,7 @@

Method Details

"maximumBackoff": "A String", # The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, + "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. }, @@ -528,7 +532,7 @@

Method Details

}, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. At most one of `pushConfig` and `bigQueryConfig` can be set. If both are empty, then the subscriber will pull and ack messages using API methods. "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } "a_key": "A String", }, @@ -543,6 +547,7 @@

Method Details

"maximumBackoff": "A String", # The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, + "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. }, @@ -574,7 +579,7 @@

Method Details

}, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. At most one of `pushConfig` and `bigQueryConfig` can be set. If both are empty, then the subscriber will pull and ack messages using API methods. "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } "a_key": "A String", }, @@ -589,6 +594,7 @@

Method Details

"maximumBackoff": "A String", # The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, + "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. }
diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index 20e68244481..1e7eefff1b5 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -132,6 +132,7 @@

Method Details

"labels": [ # Labels for this request. "A String", ], + "recommendedAction": "A String", # Recommended action after this request. }, "event": { # The event being assessed. "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. @@ -169,6 +170,7 @@

Method Details

"labels": [ # Labels for this request. "A String", ], + "recommendedAction": "A String", # Recommended action after this request. }, "event": { # The event being assessed. "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index aba86c82a64..079164c8bb9 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -139,6 +139,10 @@

Method Details

"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Settings for WAF + "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. + "wafService": "A String", # Required. The WAF service that uses this key. + }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced. "allowAmpTraffic": True or False, # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. @@ -181,6 +185,10 @@

Method Details

"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Settings for WAF + "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. + "wafService": "A String", # Required. The WAF service that uses this key. + }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced. "allowAmpTraffic": True or False, # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. @@ -248,6 +256,10 @@

Method Details

"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Settings for WAF + "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. + "wafService": "A String", # Required. The WAF service that uses this key. + }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced. "allowAmpTraffic": True or False, # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. @@ -345,6 +357,10 @@

Method Details

"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Settings for WAF + "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. + "wafService": "A String", # Required. The WAF service that uses this key. + }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced. "allowAmpTraffic": True or False, # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. @@ -417,6 +433,10 @@

Method Details

"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Settings for WAF + "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. + "wafService": "A String", # Required. The WAF service that uses this key. + }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced. "allowAmpTraffic": True or False, # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. @@ -461,6 +481,10 @@

Method Details

"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Settings for WAF + "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. + "wafService": "A String", # Required. The WAF service that uses this key. + }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced. "allowAmpTraffic": True or False, # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. @@ -504,6 +528,10 @@

Method Details

"testingChallenge": "A String", # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Settings for WAF + "wafFeature": "A String", # Required. The WAF feature for which this key is enabled. + "wafService": "A String", # Required. The WAF service that uses this key. + }, "webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites. "allowAllDomains": True or False, # If set to true, it means allowed_domains will not be enforced. "allowAmpTraffic": True or False, # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.relatedaccountgroupmemberships.html b/docs/dyn/recaptchaenterprise_v1.projects.relatedaccountgroupmemberships.html index fd01702588e..18812b0dbb1 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.relatedaccountgroupmemberships.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.relatedaccountgroupmemberships.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

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

+ search(project, body=None, x__xgafv=None)

Search group memberships related to a given account.

search_next(previous_request, previous_response)

@@ -90,11 +90,11 @@

Method Details

- search(parent, body=None, x__xgafv=None) + search(project, body=None, x__xgafv=None)
Search group memberships related to a given account.
 
 Args:
-  parent: string, Required. The name of the project to search related account group memberships from, in the format "projects/{project}". (required)
+  project: string, Required. The name of the project to search related account group memberships from, in the format "projects/{project}". (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html
index dd77743645a..7e8340737ea 100644
--- a/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html
+++ b/docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html
@@ -548,7 +548,7 @@ 

Method Details

Args: 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. + filter: string, Optional. Use of this field is not supported by version v1beta1. 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. x__xgafv: string, V1 error format. diff --git a/docs/dyn/recommender_v1beta1.organizations.locations.insightTypes.html b/docs/dyn/recommender_v1beta1.organizations.locations.insightTypes.html index f7203884c42..991370d7e10 100644 --- a/docs/dyn/recommender_v1beta1.organizations.locations.insightTypes.html +++ b/docs/dyn/recommender_v1beta1.organizations.locations.insightTypes.html @@ -151,7 +151,7 @@

Method Details

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
 
 Args:
-  name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` (required)
+  name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.html b/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.html
index fb245eb91b6..7eb4fa4e589 100644
--- a/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.html
+++ b/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.html
@@ -151,7 +151,7 @@ 

Method Details

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
 
 Args:
-  name: string, Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[RECOMMENDER_ID]/config` (required)
+  name: string, Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/recommender_v1beta1.projects.locations.insightTypes.html b/docs/dyn/recommender_v1beta1.projects.locations.insightTypes.html
index 1e5d9409921..bdd4e1588ad 100644
--- a/docs/dyn/recommender_v1beta1.projects.locations.insightTypes.html
+++ b/docs/dyn/recommender_v1beta1.projects.locations.insightTypes.html
@@ -99,7 +99,7 @@ 

Method Details

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
 
 Args:
-  name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` (required)
+  name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/recommender_v1beta1.projects.locations.recommenders.html b/docs/dyn/recommender_v1beta1.projects.locations.recommenders.html
index f5752c87f1b..02eebd53648 100644
--- a/docs/dyn/recommender_v1beta1.projects.locations.recommenders.html
+++ b/docs/dyn/recommender_v1beta1.projects.locations.recommenders.html
@@ -99,7 +99,7 @@ 

Method Details

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
 
 Args:
-  name: string, Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[RECOMMENDER_ID]/config` (required)
+  name: string, Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
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 970cd4b310d..32c4cf5978a 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html
@@ -244,7 +244,7 @@ 

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -376,7 +376,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -532,7 +532,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -608,7 +608,7 @@

Method Details

"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#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. + "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. Supported values for control imports: * 'control' (default): One JSON Control per line. "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", ], @@ -690,7 +690,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -871,7 +871,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1020,7 +1020,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1153,7 +1153,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1335,7 +1335,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1382,7 +1382,7 @@

Method Details

# Object with schema name: GoogleCloudRetailV2Product ], }, - "setMask": "A String", # Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. + "setMask": "A String", # Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. "setTime": "A String", # The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used. } diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html index 7c008c6105a..a10e0aa20f7 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html @@ -220,7 +220,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -394,7 +394,7 @@

Method Details

"variantRollupKeys": [ # The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) * inventory(place_id,attributes.key), where key is any key in the Product.inventories.attributes map. * attributes.key, where key is any key in the Product.attributes map. * pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". * customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". * customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. "A String", ], - "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 logs in or 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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. } x__xgafv: string, V1 error format. @@ -517,7 +517,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html index 07060cda54b..2957e1717e8 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html @@ -153,7 +153,7 @@

Method Details

"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#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. + "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. Supported values for control imports: * 'control' (default): One JSON Control per line. "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", ], @@ -269,7 +269,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -575,7 +575,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -762,7 +762,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. 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 b46a6378f30..d8ab78c0d71 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html @@ -179,7 +179,7 @@

Method Details

"allowMissing": True or False, # If set to true, and the Product is not found, the local inventory will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found. "localInventories": [ # Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request. { # The inventory information at a place (e.g. a store) identified by a place ID. - "attributes": { # Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * The max number of values per attribute is 10. * For text values, the length limit is 64 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB. + "attributes": { # Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * The max number of values per attribute is 10. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # If true, custom attribute values are indexed, so that it can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -196,7 +196,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -336,7 +336,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -468,7 +468,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -624,7 +624,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -700,7 +700,7 @@

Method Details

"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#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. + "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. Supported values for control imports: * 'control' (default): One JSON Control per line. "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", ], @@ -782,7 +782,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -964,7 +964,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1114,7 +1114,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1247,7 +1247,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1475,7 +1475,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1522,7 +1522,7 @@

Method Details

# Object with schema name: GoogleCloudRetailV2alphaProduct ], }, - "setMask": "A String", # Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. + "setMask": "A String", # Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. "setTime": "A String", # The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used. } @@ -1568,7 +1568,7 @@

Method Details

"allowMissing": True or False, # If set to true, and the Product is not found, the local inventory will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found. "localInventories": [ # A list of inventory information at difference places. Each place is identified by its place ID. For example, if `place1` and `place2` are stored, and this list is `[place1, place3]` with a fresher set timestamp, then the stored places will become `place1` and `place3`. An empty list removes all existing places with staler fields. At most 3000 inventories are allowed per request. { # The inventory information at a place (e.g. a store) identified by a place ID. - "attributes": { # Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * The max number of values per attribute is 10. * For text values, the length limit is 64 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB. + "attributes": { # Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * The max number of values per attribute is 10. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # If true, custom attribute values are indexed, so that it can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -1585,7 +1585,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html index 994f3c12598..a52a62e1a22 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html @@ -220,7 +220,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -395,7 +395,7 @@

Method Details

"variantRollupKeys": [ # The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) * inventory(place_id,attributes.key), where key is any key in the Product.inventories.attributes map. * attributes.key, where key is any key in the Product.attributes map. * pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". * customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". * customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. "A String", ], - "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 logs in or 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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. } x__xgafv: string, V1 error format. @@ -518,7 +518,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html index 009e94a9dc2..2119ddd4718 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html @@ -153,7 +153,7 @@

Method Details

"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#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. + "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. Supported values for control imports: * 'control' (default): One JSON Control per line. "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", ], @@ -269,7 +269,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -575,7 +575,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -762,7 +762,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. 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 0e1abe986f1..6e9490e3742 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html @@ -244,7 +244,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -376,7 +376,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -532,7 +532,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -608,7 +608,7 @@

Method Details

"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#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. + "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. Supported values for control imports: * 'control' (default): One JSON Control per line. "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", ], @@ -690,7 +690,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -871,7 +871,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1020,7 +1020,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1153,7 +1153,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1335,7 +1335,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -1382,7 +1382,7 @@

Method Details

# Object with schema name: GoogleCloudRetailV2betaProduct ], }, - "setMask": "A String", # Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. + "setMask": "A String", # Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. "setTime": "A String", # The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used. } diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html index 241bb2e0a2a..be8c64fbf25 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html @@ -220,7 +220,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -394,7 +394,7 @@

Method Details

"variantRollupKeys": [ # The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) * inventory(place_id,attributes.key), where key is any key in the Product.inventories.attributes map. * attributes.key, where key is any key in the Product.attributes map. * pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". * customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". * customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. "A String", ], - "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 logs in or 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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. } x__xgafv: string, V1 error format. @@ -517,7 +517,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html index 036d60d251d..0935bc58e64 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html @@ -153,7 +153,7 @@

Method Details

"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#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. + "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. Supported values for control imports: * 'control' (default): One JSON Control per line. "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", ], @@ -269,7 +269,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -575,7 +575,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. @@ -762,7 +762,7 @@

Method Details

"cost": 3.14, # The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). "currencyCode": "A String", # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned. "originalPrice": 3.14, # Price of the product without any discount. If zero, by default set to be the price. - "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification). + "price": 3.14, # Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). "priceEffectiveTime": "A String", # The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search. "priceExpireTime": "A String", # The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search. "priceRange": { # The price range of all variant Product having the same Product.primary_product_id. # Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 69d34aaa687..3a1aeb0e1b4 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -192,6 +192,16 @@

Method Details

"listFindingsResults": [ # Findings matching the list request. { # Result containing the Finding and its StateChange. "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding matching the search request. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -217,6 +227,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -306,6 +329,16 @@

Method Details

The object takes the form of: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -331,6 +364,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -383,6 +429,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -408,6 +464,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -473,6 +542,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -498,6 +577,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -564,6 +656,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -589,6 +691,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index 64863d2ae70..2cba103f4c2 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -125,6 +125,16 @@

Method Details

The object takes the form of: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -150,6 +160,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -202,6 +225,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -227,6 +260,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -350,6 +396,16 @@

Method Details

"listFindingsResults": [ # Findings matching the list request. { # Result containing the Finding and its StateChange. "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding matching the search request. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -375,6 +431,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -464,6 +533,16 @@

Method Details

The object takes the form of: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -489,6 +568,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -541,6 +633,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -566,6 +668,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -631,6 +746,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -656,6 +781,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -722,6 +860,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -747,6 +895,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index d5c9ff8158d..f1538fffbbc 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -192,6 +192,16 @@

Method Details

"listFindingsResults": [ # Findings matching the list request. { # Result containing the Finding and its StateChange. "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding matching the search request. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -217,6 +227,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -306,6 +329,16 @@

Method Details

The object takes the form of: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -331,6 +364,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -383,6 +429,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -408,6 +464,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -473,6 +542,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -498,6 +577,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. @@ -564,6 +656,16 @@

Method Details

An object of the form: { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. + "access": { # Represents an access event. # Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc. + "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". + "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. + "regionCode": "A String", # A CLDR. + }, + "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". + "principalEmail": "A String", # Associated email, such as "foo@google.com". + "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" + "userAgentFamily": "A String", # What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc. + }, "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" "createTime": "A String", # The time at which the finding was created in Security Command Center. @@ -589,6 +691,19 @@

Method Details

"A String", ], }, + "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org + "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "A String", + ], + "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "A String", + ], + "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. + "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING). + "A String", + ], + "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + }, "mute": "A String", # Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined). "muteInitiator": "A String", # First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. diff --git a/docs/dyn/securitycenter_v1beta2.folders.html b/docs/dyn/securitycenter_v1beta2.folders.html index faf77ee08f4..1077851ae7f 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.html +++ b/docs/dyn/securitycenter_v1beta2.folders.html @@ -89,6 +89,11 @@

Instance Methods

Returns the securityHealthAnalyticsSettings Resource.

+

+ virtualMachineThreatDetectionSettings() +

+

Returns the virtualMachineThreatDetectionSettings Resource.

+

webSecurityScannerSettings()

@@ -106,6 +111,9 @@

Instance Methods

getSecurityHealthAnalyticsSettings(name, x__xgafv=None)

Get the SecurityHealthAnalyticsSettings resource.

+

+ getVirtualMachineThreatDetectionSettings(name, x__xgafv=None)

+

Get the VirtualMachineThreatDetectionSettings resource.

getWebSecurityScannerSettings(name, x__xgafv=None)

Get the WebSecurityScannerSettings resource.

@@ -118,6 +126,9 @@

Instance Methods

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

Update the SecurityHealthAnalyticsSettings resource.

+

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

+

Update the VirtualMachineThreatDetectionSettings resource.

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

Update the WebSecurityScannerSettings resource.

@@ -216,6 +227,36 @@

Method Details

}
+
+ getVirtualMachineThreatDetectionSettings(name, x__xgafv=None) +
Get the VirtualMachineThreatDetectionSettings resource.
+
+Args:
+  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+
getWebSecurityScannerSettings(name, x__xgafv=None)
Get the WebSecurityScannerSettings resource.
@@ -390,6 +431,55 @@ 

Method Details

}
+
+ updateVirtualMachineThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) +
Update the VirtualMachineThreatDetectionSettings resource.
+
+Args:
+  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+  updateMask: string, The list 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:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+
updateWebSecurityScannerSettings(name, body=None, updateMask=None, x__xgafv=None)
Update the WebSecurityScannerSettings resource.
diff --git a/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html
new file mode 100644
index 00000000000..70d84db4392
--- /dev/null
+++ b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html
@@ -0,0 +1,119 @@
+
+
+
+

Security Command Center API . folders . virtualMachineThreatDetectionSettings

+

Instance Methods

+

+ calculate(name, x__xgafv=None)

+

Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ calculate(name, x__xgafv=None) +
Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.
+
+Args:
+  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/securitycenter_v1beta2.organizations.html b/docs/dyn/securitycenter_v1beta2.organizations.html index 01f5d1a737b..7faeaa01468 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the securityHealthAnalyticsSettings Resource.

+

+ virtualMachineThreatDetectionSettings() +

+

Returns the virtualMachineThreatDetectionSettings Resource.

+

webSecurityScannerSettings()

@@ -112,6 +117,9 @@

Instance Methods

getSubscription(name, x__xgafv=None)

Get the Subscription resource.

+

+ getVirtualMachineThreatDetectionSettings(name, x__xgafv=None)

+

Get the VirtualMachineThreatDetectionSettings resource.

getWebSecurityScannerSettings(name, x__xgafv=None)

Get the WebSecurityScannerSettings resource.

@@ -124,6 +132,9 @@

Instance Methods

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

Update the SecurityHealthAnalyticsSettings resource.

+

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

+

Update the VirtualMachineThreatDetectionSettings resource.

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

Update the WebSecurityScannerSettings resource.

@@ -268,6 +279,36 @@

Method Details

}
+
+ getVirtualMachineThreatDetectionSettings(name, x__xgafv=None) +
Get the VirtualMachineThreatDetectionSettings resource.
+
+Args:
+  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+
getWebSecurityScannerSettings(name, x__xgafv=None)
Get the WebSecurityScannerSettings resource.
@@ -442,6 +483,55 @@ 

Method Details

}
+
+ updateVirtualMachineThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) +
Update the VirtualMachineThreatDetectionSettings resource.
+
+Args:
+  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+  updateMask: string, The list 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:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+
updateWebSecurityScannerSettings(name, body=None, updateMask=None, x__xgafv=None)
Update the WebSecurityScannerSettings resource.
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html
new file mode 100644
index 00000000000..8daaaef053e
--- /dev/null
+++ b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html
@@ -0,0 +1,119 @@
+
+
+
+

Security Command Center API . organizations . virtualMachineThreatDetectionSettings

+

Instance Methods

+

+ calculate(name, x__xgafv=None)

+

Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ calculate(name, x__xgafv=None) +
Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.
+
+Args:
+  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/securitycenter_v1beta2.projects.html b/docs/dyn/securitycenter_v1beta2.projects.html index 33d112544b4..fa6ce9cd753 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.html +++ b/docs/dyn/securitycenter_v1beta2.projects.html @@ -94,6 +94,11 @@

Instance Methods

Returns the securityHealthAnalyticsSettings Resource.

+

+ virtualMachineThreatDetectionSettings() +

+

Returns the virtualMachineThreatDetectionSettings Resource.

+

webSecurityScannerSettings()

@@ -111,6 +116,9 @@

Instance Methods

getSecurityHealthAnalyticsSettings(name, x__xgafv=None)

Get the SecurityHealthAnalyticsSettings resource.

+

+ getVirtualMachineThreatDetectionSettings(name, x__xgafv=None)

+

Get the VirtualMachineThreatDetectionSettings resource.

getWebSecurityScannerSettings(name, x__xgafv=None)

Get the WebSecurityScannerSettings resource.

@@ -123,6 +131,9 @@

Instance Methods

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

Update the SecurityHealthAnalyticsSettings resource.

+

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

+

Update the VirtualMachineThreatDetectionSettings resource.

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

Update the WebSecurityScannerSettings resource.

@@ -221,6 +232,36 @@

Method Details

}
+
+ getVirtualMachineThreatDetectionSettings(name, x__xgafv=None) +
Get the VirtualMachineThreatDetectionSettings resource.
+
+Args:
+  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+
getWebSecurityScannerSettings(name, x__xgafv=None)
Get the WebSecurityScannerSettings resource.
@@ -395,6 +436,55 @@ 

Method Details

}
+
+ updateVirtualMachineThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) +
Update the VirtualMachineThreatDetectionSettings resource.
+
+Args:
+  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+  updateMask: string, The list 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:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+
updateWebSecurityScannerSettings(name, body=None, updateMask=None, x__xgafv=None)
Update the WebSecurityScannerSettings resource.
diff --git a/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html
new file mode 100644
index 00000000000..adcaa10c237
--- /dev/null
+++ b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html
@@ -0,0 +1,119 @@
+
+
+
+

Security Command Center API . projects . virtualMachineThreatDetectionSettings

+

Instance Methods

+

+ calculate(name, x__xgafv=None)

+

Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ calculate(name, x__xgafv=None) +
Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.
+
+Args:
+  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Resource capturing the settings for the Virtual Machine Threat Detection service.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+    "a_key": { # Configuration of a module.
+      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
+      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  },
+  "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
+  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
+  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
+  "updateTime": "A String", # Output only. The time the settings were last updated.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html b/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html index f68a5fe49f9..f1f8ee2aae7 100644 --- a/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html +++ b/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html @@ -164,6 +164,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], @@ -211,6 +214,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], @@ -348,6 +354,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], @@ -395,6 +404,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], diff --git a/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.html b/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.html index 60c93f03fd7..00d7e5b6938 100644 --- a/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.html +++ b/docs/dyn/serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.html @@ -153,6 +153,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }
diff --git a/docs/dyn/servicenetworking_v1.services.html b/docs/dyn/servicenetworking_v1.services.html index 05a75bb7792..83acc6c81ea 100644 --- a/docs/dyn/servicenetworking_v1.services.html +++ b/docs/dyn/servicenetworking_v1.services.html @@ -325,6 +325,7 @@

Method Details

The object takes the form of: { + "checkServiceNetworkingUsePermission": True or False, # Optional. The IAM permission check determines whether the consumer project has 'servicenetworking.services.use' permission or not. "consumerNetwork": "A String", # Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is network name. "consumerProject": { # Represents a consumer project. # NETWORK_NOT_IN_CONSUMERS_PROJECT, NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND are done when consumer_project is provided. "projectNum": "A String", # Required. Project number of the consumer that is launching the service instance. It can own the network that is peered with Google or, be a service project in an XPN where the host project has the network. diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html index cbb7d4720eb..ce6af94fd91 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html @@ -168,6 +168,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], @@ -216,6 +219,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], @@ -413,6 +419,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], @@ -461,6 +470,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }, ], diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html index e575daf91a1..c4aa57d1979 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html @@ -159,6 +159,9 @@

Method Details

}, }, ], + "supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. + "A String", + ], "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. }
diff --git a/docs/dyn/slides_v1.presentations.html b/docs/dyn/slides_v1.presentations.html index bee6c9e3ce9..1eaf5113f7a 100644 --- a/docs/dyn/slides_v1.presentations.html +++ b/docs/dyn/slides_v1.presentations.html @@ -777,7 +777,1014 @@

Method Details

"isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + "notesPage": { # A page in a presentation. # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + "layoutProperties": { # The properties of Page are only relevant for pages with page_type LAYOUT. # Layout specific properties. Only set if page_type = LAYOUT. + "displayName": "A String", # The human-readable name of the layout. + "masterObjectId": "A String", # The object ID of the master that this layout is based on. + "name": "A String", # The name of the layout. + }, + "masterProperties": { # The properties of Page that are only relevant for pages with page_type MASTER. # Master specific properties. Only set if page_type = MASTER. + "displayName": "A String", # The human-readable name of the master. + }, + "notesProperties": { # The properties of Page that are only relevant for pages with page_type NOTES. # Notes specific properties. Only set if page_type = NOTES. + "speakerNotesObjectId": "A String", # The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID. + }, + "objectId": "A String", # The object ID for this page. Object IDs used by Page and PageElement share the same namespace. + "pageElements": [ # The page elements rendered on the page. + { # A visual element rendered on a page. + "description": "A String", # The description of the page element. Combined with title to display alt text. The field is not supported for Group elements. + "elementGroup": { # A PageElement kind representing a joined collection of PageElements. # A collection of page elements joined as a single unit. + "children": [ # The collection of elements in the group. The minimum size of a group is 2. + # Object with schema name: PageElement + ], + }, + "image": { # A PageElement kind representing an image. # An image page element. + "contentUrl": "A String", # An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. + "imageProperties": { # The properties of the Image. # The properties of the image. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. + "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. + "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. + "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. + "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. + "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. + }, + "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. + "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. + "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. + { # A color and position in a gradient band. + "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. + "color": { # A themeable solid color value. # The color of the gradient stop. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. + }, + ], + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. + }, + "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the image is a placeholder image and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. + "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. + "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. + "type": "A String", # The type of the placeholder. + }, + "sourceUrl": "A String", # The source URL is the URL used to insert the image. The source URL can be empty. + }, + "line": { # A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector. # A line page element. + "lineCategory": "A String", # The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest. + "lineProperties": { # The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor. # The properties of the line. + "dashStyle": "A String", # The dash style of the line. + "endArrow": "A String", # The style of the arrow at the end of the line. + "endConnection": { # The properties for one end of a Line connection. # The connection at the end of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have an `end_connection`. + "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. + "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. + }, + "lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new lines created in the Slides editor. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "startArrow": "A String", # The style of the arrow at the beginning of the line. + "startConnection": { # The properties for one end of a Line connection. # The connection at the beginning of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have a `start_connection`. + "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. + "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the line. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "lineType": "A String", # The type of the line. + }, + "objectId": "A String", # The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace. + "shape": { # A PageElement kind representing a generic shape that does not have a more specific classification. # A generic shape. + "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the shape is a placeholder shape and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. + "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. + "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. + "type": "A String", # The type of the placeholder. + }, + "shapeProperties": { # The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape. # The properties of the shape. + "autofit": { # The autofit properties of a Shape. # The autofit properties of the shape. This property is only set for shapes that allow text. + "autofitType": "A String", # The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values. + "fontScale": 3.14, # The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that is rendered in the editor. This property is read-only. + "lineSpacingReduction": 3.14, # The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that is rendered in the editor. This property is read-only. + }, + "contentAlignment": "A String", # The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor. + "link": { # A hypertext link. # The hyperlink destination of the shape. If unset, there is no link. Links are not inherited from parent placeholders. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the shape. If unset, the outline is inherited from a parent placeholder if it exists. If the shape has no parent, then the default outline depends on the shape type, matching the defaults for new shapes created in the Slides editor. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow properties of the shape. If unset, the shadow is inherited from a parent placeholder if it exists. If the shape has no parent, then the default shadow matches the defaults for new shapes created in the Slides editor. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "shapeBackgroundFill": { # The shape background fill. # The background fill of the shape. If unset, the background fill is inherited from a parent placeholder if it exists. If the shape has no parent, then the default background fill depends on the shape type, matching the defaults for new shapes created in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + }, + "shapeType": "A String", # The type of the shape. + "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the shape. + "lists": { # The bulleted lists contained in this text, keyed by list ID. + "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. + "listId": "A String", # The ID of the list. + "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. + "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + }, + }, + "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. + { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. + "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. + "content": "A String", # The rendered content of this auto text, if available. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "type": "A String", # The type of this auto text. + }, + "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. + "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "glyph": "A String", # The rendered bullet glyph for this paragraph. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + }, + "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style + "alignment": "A String", # The text alignment for this paragraph. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + }, + }, + "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. + "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. + "content": "A String", # The text of this run. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + ], + }, + }, + "sheetsChart": { # A PageElement kind representing a linked chart embedded from Google Sheets. # A linked chart embedded from Google Sheets. Unlinked charts are represented as images. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is embedded. + "contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. + "sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart. + "chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. + "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. + "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. + "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. + "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. + "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. + }, + "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. + "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. + "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. + { # A color and position in a gradient band. + "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. + "color": { # A themeable solid color value. # The color of the gradient stop. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. + }, + ], + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. + }, + }, + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + "size": { # A width and height. # The size of the page element. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "table": { # A PageElement kind representing a table. # A table page element. + "columns": 42, # Number of columns in the table. + "horizontalBorderRows": [ # Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns. + { # Contents of each border row in a table. + "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. + { # The properties of each border cell. + "location": { # A location of a single table cell within a table. # The location of the border within the border table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. + "dashStyle": "A String", # The dash style of the border. + "tableBorderFill": { # The fill of the border. # The fill of the table border. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + }, + ], + "rows": 42, # Number of rows in the table. + "tableColumns": [ # Properties of each column. + { # Properties of each column in a table. + "columnWidth": { # A magnitude in a single direction in the specified units. # Width of a column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "tableRows": [ # Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1. + { # Properties and contents of each row in a table. + "rowHeight": { # A magnitude in a single direction in the specified units. # Height of a row. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "tableCells": [ # Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table. + { # Properties and contents of each table cell. + "columnSpan": 42, # Column span of the cell. + "location": { # A location of a single table cell within a table. # The location of the cell within the table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "rowSpan": 42, # Row span of the cell. + "tableCellProperties": { # The properties of the TableCell. # The properties of the table cell. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor. + "tableCellBackgroundFill": { # The table cell background fill. # The background fill of the table cell. The default fill matches the fill for newly created table cells in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + }, + "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the cell. + "lists": { # The bulleted lists contained in this text, keyed by list ID. + "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. + "listId": "A String", # The ID of the list. + "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. + "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + }, + }, + "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. + { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. + "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. + "content": "A String", # The rendered content of this auto text, if available. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "type": "A String", # The type of this auto text. + }, + "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. + "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "glyph": "A String", # The rendered bullet glyph for this paragraph. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + }, + "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style + "alignment": "A String", # The text alignment for this paragraph. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + }, + }, + "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. + "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. + "content": "A String", # The text of this run. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + ], + }, + }, + ], + "tableRowProperties": { # Properties of each row in a table. # Properties of the row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # Minimum height of the row. The row will be rendered in the Slides editor at a height equal to or greater than this value in order to show all the text in the row's cell(s). + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + "verticalBorderRows": [ # Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns. + { # Contents of each border row in a table. + "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. + { # The properties of each border cell. + "location": { # A location of a single table cell within a table. # The location of the border within the border table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. + "dashStyle": "A String", # The dash style of the border. + "tableBorderFill": { # The fill of the border. # The fill of the table border. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + }, + ], + }, + "title": "A String", # The title of the page element. Combined with description to display alt text. The field is not supported for Group elements. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # The transform of the page element. The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field. The initial transform for the newly created Group is always the identity transform. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "video": { # A PageElement kind representing a video. # A video page element. + "id": "A String", # The video source's unique identifier for this video. + "source": "A String", # The video source. + "url": "A String", # An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change. + "videoProperties": { # The properties of the Video. # The properties of the video. + "autoPlay": True or False, # Whether to enable video autoplay when the page is displayed in present mode. Defaults to false. + "end": 42, # The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end. + "mute": True or False, # Whether to mute the audio during video playback. Defaults to false. + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the video. The default outline matches the defaults for new videos created in the Slides editor. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "start": 42, # The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning. + }, + }, + "wordArt": { # A PageElement kind representing word art. # A word art page element. + "renderedText": "A String", # The text rendered as word art. + }, + }, + ], + "pageProperties": { # The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties. # The properties of the page. + "colorScheme": { # The palette of predefined colors for a page. # The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme, matching the defaults in the Slides editor. Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only the color scheme on `Master` pages can be updated. To update the field, a color scheme containing mappings from all the first 12 ThemeColorTypes to their concrete colors must be provided. Colors for the remaining ThemeColorTypes will be ignored. + "colors": [ # The ThemeColorType and corresponding concrete color pairs. + { # A pair mapping a theme color type to the concrete color it represents. + "color": { # An RGB color. # The concrete color corresponding to the theme color type above. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "type": "A String", # The type of the theme color. + }, + ], + }, + "pageBackgroundFill": { # The page background fill. # The background fill of the page. If unset, the background fill is inherited from a parent page if it exists. If the page has no parent, then the background fill defaults to the corresponding fill in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "stretchedPictureFill": { # The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container. # Stretched picture fill. + "contentUrl": "A String", # Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. + "size": { # A width and height. # The original size of the picture fill. This field is read-only. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + }, + }, + "pageType": "A String", # The type of the page. + "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + }, }, }, "updateSlidesPosition": { # Updates the position of slides in the presentation. # Updates the position of a set of slides in the presentation. @@ -2045,12 +3052,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -3061,12 +4063,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -4075,12 +5072,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -5101,12 +6093,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. @@ -6128,12 +7115,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -7144,12 +8126,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -8158,12 +9135,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -9184,12 +10156,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. @@ -10218,12 +11185,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -11234,12 +12196,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -12248,12 +13205,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -13274,12 +14226,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. diff --git a/docs/dyn/slides_v1.presentations.pages.html b/docs/dyn/slides_v1.presentations.pages.html index aab9b5ea3d9..68f1bdaf0f9 100644 --- a/docs/dyn/slides_v1.presentations.pages.html +++ b/docs/dyn/slides_v1.presentations.pages.html @@ -1110,12 +1110,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }
diff --git a/docs/dyn/sourcerepo_v1.projects.repos.html b/docs/dyn/sourcerepo_v1.projects.repos.html index 6a4b157a831..a3418eed504 100644 --- a/docs/dyn/sourcerepo_v1.projects.repos.html +++ b/docs/dyn/sourcerepo_v1.projects.repos.html @@ -224,7 +224,7 @@

Method Details

Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, 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). + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html index e24b343f22d..94195d291c1 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.html @@ -92,7 +92,7 @@

Instance Methods

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

dropDatabase(database, x__xgafv=None)

-

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`.

+

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

get(name, x__xgafv=None)

Gets the state of a Cloud Spanner database.

@@ -179,7 +179,7 @@

Method Details

dropDatabase(database, x__xgafv=None) -
Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`.
+  
Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.
 
 Args:
   database: string, Required. The database to be dropped. (required)
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
index 0dce47116b9..f59904240bc 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
@@ -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. @@ -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. @@ -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. @@ -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. }, ], }, @@ -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.projects.locations.customClasses.html b/docs/dyn/speech_v1.projects.locations.customClasses.html index 8d84265cea3..922309633df 100644 --- a/docs/dyn/speech_v1.projects.locations.customClasses.html +++ b/docs/dyn/speech_v1.projects.locations.customClasses.html @@ -106,7 +106,7 @@

Method Details

Create a custom class.
 
 Args:
-  parent: string, Required. The parent resource where this custom class will be created. Format: {api_version}/projects/{project}/locations/{location}/customClasses (required)
+  parent: string, Required. The parent resource where this custom class will be created. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -147,7 +147,7 @@ 

Method Details

Delete a custom class.
 
 Args:
-  name: string, Required. The name of the custom class to delete. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} (required)
+  name: string, Required. The name of the custom class to delete. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -165,7 +165,7 @@ 

Method Details

Get a custom class.
 
 Args:
-  name: string, Required. The name of the custom class to retrieve. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} (required)
+  name: string, Required. The name of the custom class to retrieve. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -190,7 +190,7 @@ 

Method Details

List custom classes.
 
 Args:
-  parent: string, Required. The parent, which owns this collection of custom classes. Format: {api_version}/projects/{project}/locations/{location}/customClasses (required)
+  parent: string, Required. The parent, which owns this collection of custom classes. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   pageSize: integer, The maximum number of custom classes to return. The service may return fewer than this value. If unspecified, at most 50 custom classes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListCustomClass` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomClass` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/speech_v1.projects.locations.phraseSets.html b/docs/dyn/speech_v1.projects.locations.phraseSets.html
index df16ee78f8d..3c3c03f552c 100644
--- a/docs/dyn/speech_v1.projects.locations.phraseSets.html
+++ b/docs/dyn/speech_v1.projects.locations.phraseSets.html
@@ -106,7 +106,7 @@ 

Method Details

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.
 
 Args:
-  parent: string, Required. The parent resource where this phrase set will be created. Format: {api_version}/projects/{project}/locations/{location}/phraseSets (required)
+  parent: string, Required. The parent resource where this phrase set will be created. Format: `projects/{project}/locations/{location}/phraseSets` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -115,7 +115,7 @@ 

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -136,7 +136,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -149,7 +149,7 @@

Method Details

Delete a phrase set.
 
 Args:
-  name: string, Required. The name of the phrase set to delete. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} (required)
+  name: string, Required. The name of the phrase set to delete. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,7 +167,7 @@ 

Method Details

Get a phrase set.
 
 Args:
-  name: string, Required. The name of the phrase set to retrieve. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} (required)
+  name: string, Required. The name of the phrase set to retrieve. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -180,7 +180,7 @@ 

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -193,7 +193,7 @@

Method Details

List phrase sets.
 
 Args:
-  parent: string, Required. The parent, which owns this collection of phrase set. Format: projects/{project}/locations/{location} (required)
+  parent: string, Required. The parent, which owns this collection of phrase set. Format: `projects/{project}/locations/{location}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   pageSize: integer, The maximum number of phrase sets to return. The service may return fewer than this value. If unspecified, at most 50 phrase sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListPhraseSet` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPhraseSet` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -211,7 +211,7 @@ 

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -248,7 +248,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -268,7 +268,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, diff --git a/docs/dyn/speech_v1.speech.html b/docs/dyn/speech_v1.speech.html index 700556f7802..c9a558b58c1 100644 --- a/docs/dyn/speech_v1.speech.html +++ b/docs/dyn/speech_v1.speech.html @@ -123,7 +123,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -241,7 +241,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, diff --git a/docs/dyn/speech_v1p1beta1.projects.locations.customClasses.html b/docs/dyn/speech_v1p1beta1.projects.locations.customClasses.html index 3c2acb5ac2d..b141912344b 100644 --- a/docs/dyn/speech_v1p1beta1.projects.locations.customClasses.html +++ b/docs/dyn/speech_v1p1beta1.projects.locations.customClasses.html @@ -106,7 +106,7 @@

Method Details

Create a custom class.
 
 Args:
-  parent: string, Required. The parent resource where this custom class will be created. Format: {api_version}/projects/{project}/locations/{location}/customClasses (required)
+  parent: string, Required. The parent resource where this custom class will be created. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -147,7 +147,7 @@ 

Method Details

Delete a custom class.
 
 Args:
-  name: string, Required. The name of the custom class to delete. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} (required)
+  name: string, Required. The name of the custom class to delete. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -165,7 +165,7 @@ 

Method Details

Get a custom class.
 
 Args:
-  name: string, Required. The name of the custom class to retrieve. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} (required)
+  name: string, Required. The name of the custom class to retrieve. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -190,7 +190,7 @@ 

Method Details

List custom classes.
 
 Args:
-  parent: string, Required. The parent, which owns this collection of custom classes. Format: {api_version}/projects/{project}/locations/{location}/customClasses (required)
+  parent: string, Required. The parent, which owns this collection of custom classes. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   pageSize: integer, The maximum number of custom classes to return. The service may return fewer than this value. If unspecified, at most 50 custom classes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListCustomClass` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomClass` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/speech_v1p1beta1.projects.locations.phraseSets.html b/docs/dyn/speech_v1p1beta1.projects.locations.phraseSets.html
index cafc5159841..a349eabbb65 100644
--- a/docs/dyn/speech_v1p1beta1.projects.locations.phraseSets.html
+++ b/docs/dyn/speech_v1p1beta1.projects.locations.phraseSets.html
@@ -106,7 +106,7 @@ 

Method Details

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.
 
 Args:
-  parent: string, Required. The parent resource where this phrase set will be created. Format: {api_version}/projects/{project}/locations/{location}/phraseSets (required)
+  parent: string, Required. The parent resource where this phrase set will be created. Format: `projects/{project}/locations/{location}/phraseSets` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -115,7 +115,7 @@ 

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -136,7 +136,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -149,7 +149,7 @@

Method Details

Delete a phrase set.
 
 Args:
-  name: string, Required. The name of the phrase set to delete. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} (required)
+  name: string, Required. The name of the phrase set to delete. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,7 +167,7 @@ 

Method Details

Get a phrase set.
 
 Args:
-  name: string, Required. The name of the phrase set to retrieve. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} (required)
+  name: string, Required. The name of the phrase set to retrieve. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -180,7 +180,7 @@ 

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -193,7 +193,7 @@

Method Details

List phrase sets.
 
 Args:
-  parent: string, Required. The parent, which owns this collection of phrase set. Format: projects/{project}/locations/{location} (required)
+  parent: string, Required. The parent, which owns this collection of phrase set. Format: `projects/{project}/locations/{location}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. (required)
   pageSize: integer, The maximum number of phrase sets to return. The service may return fewer than this value. If unspecified, at most 50 phrase sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListPhraseSet` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPhraseSet` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -211,7 +211,7 @@ 

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -248,7 +248,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -268,7 +268,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, diff --git a/docs/dyn/speech_v1p1beta1.speech.html b/docs/dyn/speech_v1p1beta1.speech.html index bb77766a18b..ed305c89352 100644 --- a/docs/dyn/speech_v1p1beta1.speech.html +++ b/docs/dyn/speech_v1p1beta1.speech.html @@ -123,7 +123,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, @@ -253,7 +253,7 @@

Method Details

"boost": 3.14, # Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "name": "A String", # The resource name of the phrase set. "phrases": [ # A list of word and phrases. - { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). + { # A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value. "boost": 3.14, # Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. "value": "A String", # The phrase itself. }, diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 0c0d47ba7ce..0f66156e2ff 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -814,7 +814,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -829,7 +829,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -940,7 +940,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -957,7 +957,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -971,10 +971,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -998,7 +998,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -1148,7 +1148,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -1163,7 +1163,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -1274,7 +1274,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -1291,7 +1291,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -1305,10 +1305,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -1332,7 +1332,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -1454,7 +1454,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -1469,7 +1469,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -1580,7 +1580,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -1597,7 +1597,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -1611,10 +1611,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -1638,7 +1638,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -1724,7 +1724,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -1739,7 +1739,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -1850,7 +1850,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -1867,7 +1867,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -1881,10 +1881,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -1908,7 +1908,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -2805,7 +2805,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -2820,7 +2820,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -2931,7 +2931,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -2948,7 +2948,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -2962,10 +2962,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -2989,7 +2989,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index db4dec76ce2..2b53f46824a 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -814,7 +814,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -829,7 +829,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -940,7 +940,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -957,7 +957,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -971,10 +971,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -998,7 +998,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -1148,7 +1148,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -1163,7 +1163,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -1274,7 +1274,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -1291,7 +1291,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -1305,10 +1305,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -1332,7 +1332,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -1454,7 +1454,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -1469,7 +1469,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -1580,7 +1580,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -1597,7 +1597,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -1611,10 +1611,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -1638,7 +1638,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -1724,7 +1724,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -1739,7 +1739,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -1850,7 +1850,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -1867,7 +1867,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -1881,10 +1881,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -1908,7 +1908,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, @@ -2805,7 +2805,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. - "databaseInstalledVersion": "A String", # Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50 + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**. "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. @@ -2820,7 +2820,7 @@

Method Details

"available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, - "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. "instanceType": "A String", # The instance type. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. @@ -2931,7 +2931,7 @@

Method Details

"value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. }, ], - "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. "denyMaintenancePeriods": [ # Deny maintenance periods { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied. "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 @@ -2948,7 +2948,7 @@

Method Details

}, "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` - "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**). + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**). { # An entry for an Access Control list. "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. "kind": "A String", # This is always **sql#aclEntry**. @@ -2962,10 +2962,10 @@

Method Details

}, "kind": "A String", # This is always **sql#settings**. "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. - "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. "kind": "A String", # This is always **sql#locationPreference**. "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use. - "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. }, "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. "day": 42, # day of week (1-7), starting on Monday. @@ -2989,7 +2989,7 @@

Method Details

}, "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. - "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. + "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance. "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. "a_key": "A String", }, diff --git a/docs/dyn/storagetransfer_v1.transferJobs.html b/docs/dyn/storagetransfer_v1.transferJobs.html index f8207d53fb9..40a6aac2c69 100644 --- a/docs/dyn/storagetransfer_v1.transferJobs.html +++ b/docs/dyn/storagetransfer_v1.transferJobs.html @@ -115,12 +115,12 @@

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 a TransferOperation has been created for this JobConfig. - "loggingConfig": { # Logging configuration. # Logging configuration. - "enableOnpremGcsTransferLogs": True or False, # Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer. - "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration. + "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer. + "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], - "logActions": [ # Actions to be logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], }, @@ -171,7 +171,7 @@

Method Details

}, "azureBlobStorageDataSource": { # An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names). # An Azure Blob Storage data source. "azureCredentials": { # Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). # Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). - "sasToken": "A String", # Required. Azure shared access signature (SAS). *Note:*Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-stages). During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). + "sasToken": "A String", # Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). }, "container": "A String", # Required. The container to transfer from the Azure Storage account. "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. @@ -185,6 +185,10 @@

Method Details

"bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). }, + "gcsIntermediateDataLocation": { # In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. # Cloud Storage intermediate data location. + "bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). + "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). + }, "httpDataSource": { # An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer. # An HTTP URL data source. "listUrl": "A String", # Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. }, @@ -214,6 +218,12 @@

Method Details

"transferOptions": { # TransferOptions define the actions to be performed on objects in a transfer. # If the option delete_objects_unique_in_sink is `true` and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error. "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. + "metadataOptions": { # Specifies the metadata options for running a transfer. # Represents the selected metadata options for a transfer job. + "gid": "A String", # Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system. + "mode": "A String", # Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system. + "symlink": "A String", # Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system. + "uid": "A String", # Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system. + }, "overwriteObjectsAlreadyExistingInSink": True or False, # When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. }, }, @@ -233,12 +243,12 @@

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 a TransferOperation has been created for this JobConfig. - "loggingConfig": { # Logging configuration. # Logging configuration. - "enableOnpremGcsTransferLogs": True or False, # Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer. - "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration. + "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer. + "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], - "logActions": [ # Actions to be logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], }, @@ -289,7 +299,7 @@

Method Details

}, "azureBlobStorageDataSource": { # An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names). # An Azure Blob Storage data source. "azureCredentials": { # Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). # Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). - "sasToken": "A String", # Required. Azure shared access signature (SAS). *Note:*Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-stages). During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). + "sasToken": "A String", # Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). }, "container": "A String", # Required. The container to transfer from the Azure Storage account. "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. @@ -303,6 +313,10 @@

Method Details

"bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). }, + "gcsIntermediateDataLocation": { # In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. # Cloud Storage intermediate data location. + "bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). + "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). + }, "httpDataSource": { # An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer. # An HTTP URL data source. "listUrl": "A String", # Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. }, @@ -332,6 +346,12 @@

Method Details

"transferOptions": { # TransferOptions define the actions to be performed on objects in a transfer. # If the option delete_objects_unique_in_sink is `true` and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error. "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. + "metadataOptions": { # Specifies the metadata options for running a transfer. # Represents the selected metadata options for a transfer job. + "gid": "A String", # Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system. + "mode": "A String", # Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system. + "symlink": "A String", # Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system. + "uid": "A String", # Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system. + }, "overwriteObjectsAlreadyExistingInSink": True or False, # When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. }, }, @@ -359,12 +379,12 @@

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 a TransferOperation has been created for this JobConfig. - "loggingConfig": { # Logging configuration. # Logging configuration. - "enableOnpremGcsTransferLogs": True or False, # Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer. - "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration. + "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer. + "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], - "logActions": [ # Actions to be logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], }, @@ -415,7 +435,7 @@

Method Details

}, "azureBlobStorageDataSource": { # An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names). # An Azure Blob Storage data source. "azureCredentials": { # Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). # Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). - "sasToken": "A String", # Required. Azure shared access signature (SAS). *Note:*Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-stages). During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). + "sasToken": "A String", # Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). }, "container": "A String", # Required. The container to transfer from the Azure Storage account. "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. @@ -429,6 +449,10 @@

Method Details

"bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). }, + "gcsIntermediateDataLocation": { # In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. # Cloud Storage intermediate data location. + "bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). + "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). + }, "httpDataSource": { # An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer. # An HTTP URL data source. "listUrl": "A String", # Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. }, @@ -458,6 +482,12 @@

Method Details

"transferOptions": { # TransferOptions define the actions to be performed on objects in a transfer. # If the option delete_objects_unique_in_sink is `true` and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error. "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. + "metadataOptions": { # Specifies the metadata options for running a transfer. # Represents the selected metadata options for a transfer job. + "gid": "A String", # Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system. + "mode": "A String", # Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system. + "symlink": "A String", # Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system. + "uid": "A String", # Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system. + }, "overwriteObjectsAlreadyExistingInSink": True or False, # When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. }, }, @@ -489,12 +519,12 @@

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 a TransferOperation has been created for this JobConfig. - "loggingConfig": { # Logging configuration. # Logging configuration. - "enableOnpremGcsTransferLogs": True or False, # Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer. - "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration. + "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer. + "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], - "logActions": [ # Actions to be logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], }, @@ -545,7 +575,7 @@

Method Details

}, "azureBlobStorageDataSource": { # An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names). # An Azure Blob Storage data source. "azureCredentials": { # Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). # Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). - "sasToken": "A String", # Required. Azure shared access signature (SAS). *Note:*Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-stages). During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). + "sasToken": "A String", # Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). }, "container": "A String", # Required. The container to transfer from the Azure Storage account. "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. @@ -559,6 +589,10 @@

Method Details

"bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). }, + "gcsIntermediateDataLocation": { # In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. # Cloud Storage intermediate data location. + "bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). + "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). + }, "httpDataSource": { # An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer. # An HTTP URL data source. "listUrl": "A String", # Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. }, @@ -588,6 +622,12 @@

Method Details

"transferOptions": { # TransferOptions define the actions to be performed on objects in a transfer. # If the option delete_objects_unique_in_sink is `true` and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error. "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. + "metadataOptions": { # Specifies the metadata options for running a transfer. # Represents the selected metadata options for a transfer job. + "gid": "A String", # Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system. + "mode": "A String", # Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system. + "symlink": "A String", # Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system. + "uid": "A String", # Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system. + }, "overwriteObjectsAlreadyExistingInSink": True or False, # When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. }, }, @@ -621,18 +661,18 @@

Method Details

{ # Request passed to UpdateTransferJob. "projectId": "A String", # Required. The ID of the Google Cloud project that owns the job. - "transferJob": { # This resource represents the configuration of a transfer job that runs periodically. # Required. The job to update. `transferJob` is expected to specify only four fields: description, transfer_spec, notification_config, and status. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires `storagetransfer.jobs.delete` permissions. + "transferJob": { # This resource represents the configuration of a transfer job that runs periodically. # Required. The job to update. `transferJob` is expected to specify one or more of five fields: description, transfer_spec, notification_config, [logging_config[TransferJob.logging_config], and status. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires `storagetransfer.jobs.delete` permissions. "creationTime": "A String", # Output only. The time that the transfer job was created. "deletionTime": "A String", # Output only. The time that the transfer job was deleted. "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 a TransferOperation has been created for this JobConfig. - "loggingConfig": { # Logging configuration. # Logging configuration. - "enableOnpremGcsTransferLogs": True or False, # Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer. - "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration. + "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer. + "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], - "logActions": [ # Actions to be logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], }, @@ -683,7 +723,7 @@

Method Details

}, "azureBlobStorageDataSource": { # An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names). # An Azure Blob Storage data source. "azureCredentials": { # Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). # Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). - "sasToken": "A String", # Required. Azure shared access signature (SAS). *Note:*Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-stages). During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). + "sasToken": "A String", # Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). }, "container": "A String", # Required. The container to transfer from the Azure Storage account. "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. @@ -697,6 +737,10 @@

Method Details

"bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). }, + "gcsIntermediateDataLocation": { # In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. # Cloud Storage intermediate data location. + "bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). + "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). + }, "httpDataSource": { # An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer. # An HTTP URL data source. "listUrl": "A String", # Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. }, @@ -726,11 +770,17 @@

Method Details

"transferOptions": { # TransferOptions define the actions to be performed on objects in a transfer. # If the option delete_objects_unique_in_sink is `true` and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error. "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. + "metadataOptions": { # Specifies the metadata options for running a transfer. # Represents the selected metadata options for a transfer job. + "gid": "A String", # Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system. + "mode": "A String", # Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system. + "symlink": "A String", # Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system. + "uid": "A String", # Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system. + }, "overwriteObjectsAlreadyExistingInSink": True or False, # When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. }, }, }, - "updateTransferJobFieldMask": "A String", # The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: description, transfer_spec, notification_config, and status. To update the `transfer_spec` of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT. + "updateTransferJobFieldMask": "A String", # The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update the `transfer_spec` of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT. } x__xgafv: string, V1 error format. @@ -747,12 +797,12 @@

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 a TransferOperation has been created for this JobConfig. - "loggingConfig": { # Logging configuration. # Logging configuration. - "enableOnpremGcsTransferLogs": True or False, # Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer. - "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "loggingConfig": { # Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. # Logging configuration. + "enableOnpremGcsTransferLogs": True or False, # For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer. + "logActionStates": [ # States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], - "logActions": [ # Actions to be logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources. + "logActions": [ # Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead. "A String", ], }, @@ -803,7 +853,7 @@

Method Details

}, "azureBlobStorageDataSource": { # An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names). # An Azure Blob Storage data source. "azureCredentials": { # Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). # Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials). - "sasToken": "A String", # Required. Azure shared access signature (SAS). *Note:*Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-stages). During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). + "sasToken": "A String", # Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). }, "container": "A String", # Required. The container to transfer from the Azure Storage account. "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. @@ -817,6 +867,10 @@

Method Details

"bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). }, + "gcsIntermediateDataLocation": { # In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. # Cloud Storage intermediate data location. + "bucketName": "A String", # Required. Cloud Storage bucket name. Must meet [Bucket Name Requirements](/storage/docs/naming#requirements). + "path": "A String", # Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet [Object Name Requirements](/storage/docs/naming#objectnames). + }, "httpDataSource": { # An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer. # An HTTP URL data source. "listUrl": "A String", # Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. }, @@ -846,6 +900,12 @@

Method Details

"transferOptions": { # TransferOptions define the actions to be performed on objects in a transfer. # If the option delete_objects_unique_in_sink is `true` and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error. "deleteObjectsFromSourceAfterTransfer": True or False, # Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. "deleteObjectsUniqueInSink": True or False, # Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. + "metadataOptions": { # Specifies the metadata options for running a transfer. # Represents the selected metadata options for a transfer job. + "gid": "A String", # Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system. + "mode": "A String", # Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system. + "symlink": "A String", # Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system. + "uid": "A String", # Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system. + }, "overwriteObjectsAlreadyExistingInSink": True or False, # When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. }, }, diff --git a/docs/dyn/testing_v1.projects.testMatrices.html b/docs/dyn/testing_v1.projects.testMatrices.html index 2eeed5e5399..44f2b43415d 100644 --- a/docs/dyn/testing_v1.projects.testMatrices.html +++ b/docs/dyn/testing_v1.projects.testMatrices.html @@ -269,8 +269,6 @@

Method Details

}, "appInitialActivity": "A String", # The initial activity that should be used to start the app. "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. - "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. "roboDirectives": [ # A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. { # Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click. "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. @@ -464,8 +462,6 @@

Method Details

}, "appInitialActivity": "A String", # The initial activity that should be used to start the app. "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. - "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. "roboDirectives": [ # A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. { # Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click. "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. @@ -763,8 +759,6 @@

Method Details

}, "appInitialActivity": "A String", # The initial activity that should be used to start the app. "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. - "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. "roboDirectives": [ # A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. { # Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click. "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. @@ -958,8 +952,6 @@

Method Details

}, "appInitialActivity": "A String", # The initial activity that should be used to start the app. "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. - "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. "roboDirectives": [ # A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. { # Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click. "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. @@ -1264,8 +1256,6 @@

Method Details

}, "appInitialActivity": "A String", # The initial activity that should be used to start the app. "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. - "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. "roboDirectives": [ # A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. { # Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click. "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. @@ -1459,8 +1449,6 @@

Method Details

}, "appInitialActivity": "A String", # The initial activity that should be used to start the app. "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. - "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. "roboDirectives": [ # A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. { # Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click. "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. diff --git a/docs/dyn/transcoder_v1.html b/docs/dyn/transcoder_v1.html new file mode 100644 index 00000000000..e866af9ff2b --- /dev/null +++ b/docs/dyn/transcoder_v1.html @@ -0,0 +1,111 @@ + + + +

Transcoder API

+

Instance Methods

+

+ 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/transcoder_v1.projects.html b/docs/dyn/transcoder_v1.projects.html new file mode 100644 index 00000000000..7bd301dfa46 --- /dev/null +++ b/docs/dyn/transcoder_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Transcoder 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/transcoder_v1.projects.locations.html b/docs/dyn/transcoder_v1.projects.locations.html new file mode 100644 index 00000000000..4b6f6f09583 --- /dev/null +++ b/docs/dyn/transcoder_v1.projects.locations.html @@ -0,0 +1,96 @@ + + + +

Transcoder API . projects . locations

+

Instance Methods

+

+ jobTemplates() +

+

Returns the jobTemplates Resource.

+ +

+ jobs() +

+

Returns the jobs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Transcoder API . projects . locations . jobTemplates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a job template in the specified region.

+

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

+

Deletes a job template.

+

+ get(name, x__xgafv=None)

+

Returns the job template data.

+

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

+

Lists job templates in the specified region.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, jobTemplateId=None, x__xgafv=None) +
Creates a job template in the specified region.
+
+Args:
+  parent: string, Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Transcoding job template resource.
+  "config": { # Job configuration # The configuration for this template.
+    "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+      { # Ad break.
+        "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+      },
+    ],
+    "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+      { # Edit atom.
+        "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+        "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+          "A String",
+        ],
+        "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+        "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+      },
+    ],
+    "elementaryStreams": [ # List of elementary streams.
+      { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+        "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+          "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+          "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+          "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+            "A String",
+          ],
+          "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+              "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+              "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+              "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+            },
+          ],
+          "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+        },
+        "key": "A String", # A unique key for this elementary stream.
+        "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+          "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+            },
+          ],
+        },
+        "videoStream": { # Video stream resource. # Encoding of a video stream.
+          "h264": { # H264 codec settings. # H264 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "h265": { # H265 codec settings. # H265 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "vp9": { # VP9 codec settings. # VP9 codec settings.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+        },
+      },
+    ],
+    "inputs": [ # List of input assets stored in Cloud Storage.
+      { # Input asset.
+        "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+        "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+          "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+            "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+            "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+            "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+          },
+          "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+            "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+            "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+            "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+          },
+          "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+            "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+            "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+          },
+          "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+            "enabled": True or False, # Enable deblocker. The default is `false`.
+            "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+          },
+          "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+            "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+            "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+          },
+          "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+            "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+            "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+          },
+        },
+        "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+      },
+    ],
+    "manifests": [ # List of output manifests.
+      { # Manifest configuration.
+        "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+        "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+          "A String",
+        ],
+        "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+      },
+    ],
+    "muxStreams": [ # List of multiplexing settings for output streams.
+      { # Multiplexing settings for output stream.
+        "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+        "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+          "A String",
+        ],
+        "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+        "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+        "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+          "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+          "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+        },
+      },
+    ],
+    "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+      "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+    },
+    "overlays": [ # List of overlays on the output video, in descending Z-order.
+      { # Overlay configuration.
+        "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+          { # Animation types.
+            "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+              "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+            },
+            "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+              "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+              "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+              "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+            "animationStatic": { # Display static overlay object. # Display static overlay object.
+              "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+          },
+        ],
+        "image": { # Overlaid jpeg image. # Image overlay.
+          "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+          "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+            "x": 3.14, # Normalized x coordinate.
+            "y": 3.14, # Normalized y coordinate.
+          },
+          "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+        },
+      },
+    ],
+    "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+      "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+    },
+    "spriteSheets": [ # List of output sprite sheets.
+      { # Sprite sheet configuration.
+        "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+        "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+        "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+        "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+        "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+        "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+        "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+        "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+        "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+        "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+        "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+      },
+    ],
+  },
+  "name": "A String", # The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`
+}
+
+  jobTemplateId: string, Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression `a-zA-Z*`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Transcoding job template resource.
+  "config": { # Job configuration # The configuration for this template.
+    "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+      { # Ad break.
+        "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+      },
+    ],
+    "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+      { # Edit atom.
+        "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+        "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+          "A String",
+        ],
+        "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+        "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+      },
+    ],
+    "elementaryStreams": [ # List of elementary streams.
+      { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+        "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+          "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+          "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+          "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+            "A String",
+          ],
+          "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+              "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+              "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+              "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+            },
+          ],
+          "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+        },
+        "key": "A String", # A unique key for this elementary stream.
+        "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+          "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+            },
+          ],
+        },
+        "videoStream": { # Video stream resource. # Encoding of a video stream.
+          "h264": { # H264 codec settings. # H264 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "h265": { # H265 codec settings. # H265 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "vp9": { # VP9 codec settings. # VP9 codec settings.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+        },
+      },
+    ],
+    "inputs": [ # List of input assets stored in Cloud Storage.
+      { # Input asset.
+        "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+        "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+          "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+            "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+            "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+            "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+          },
+          "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+            "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+            "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+            "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+          },
+          "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+            "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+            "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+          },
+          "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+            "enabled": True or False, # Enable deblocker. The default is `false`.
+            "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+          },
+          "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+            "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+            "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+          },
+          "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+            "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+            "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+          },
+        },
+        "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+      },
+    ],
+    "manifests": [ # List of output manifests.
+      { # Manifest configuration.
+        "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+        "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+          "A String",
+        ],
+        "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+      },
+    ],
+    "muxStreams": [ # List of multiplexing settings for output streams.
+      { # Multiplexing settings for output stream.
+        "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+        "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+          "A String",
+        ],
+        "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+        "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+        "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+          "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+          "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+        },
+      },
+    ],
+    "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+      "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+    },
+    "overlays": [ # List of overlays on the output video, in descending Z-order.
+      { # Overlay configuration.
+        "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+          { # Animation types.
+            "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+              "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+            },
+            "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+              "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+              "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+              "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+            "animationStatic": { # Display static overlay object. # Display static overlay object.
+              "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+          },
+        ],
+        "image": { # Overlaid jpeg image. # Image overlay.
+          "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+          "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+            "x": 3.14, # Normalized x coordinate.
+            "y": 3.14, # Normalized y coordinate.
+          },
+          "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+        },
+      },
+    ],
+    "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+      "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+    },
+    "spriteSheets": [ # List of output sprite sheets.
+      { # Sprite sheet configuration.
+        "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+        "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+        "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+        "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+        "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+        "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+        "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+        "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+        "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+        "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+        "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+      },
+    ],
+  },
+  "name": "A String", # The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`
+}
+
+ +
+ delete(name, allowMissing=None, x__xgafv=None) +
Deletes a job template.
+
+Args:
+  name: string, Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}` (required)
+  allowMissing: boolean, If set to true, and the job template is not found, the request will succeed but no action will be taken on the server.
+  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) +
Returns the job template data.
+
+Args:
+  name: string, Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Transcoding job template resource.
+  "config": { # Job configuration # The configuration for this template.
+    "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+      { # Ad break.
+        "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+      },
+    ],
+    "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+      { # Edit atom.
+        "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+        "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+          "A String",
+        ],
+        "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+        "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+      },
+    ],
+    "elementaryStreams": [ # List of elementary streams.
+      { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+        "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+          "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+          "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+          "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+            "A String",
+          ],
+          "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+              "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+              "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+              "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+            },
+          ],
+          "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+        },
+        "key": "A String", # A unique key for this elementary stream.
+        "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+          "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+            },
+          ],
+        },
+        "videoStream": { # Video stream resource. # Encoding of a video stream.
+          "h264": { # H264 codec settings. # H264 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "h265": { # H265 codec settings. # H265 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "vp9": { # VP9 codec settings. # VP9 codec settings.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+        },
+      },
+    ],
+    "inputs": [ # List of input assets stored in Cloud Storage.
+      { # Input asset.
+        "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+        "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+          "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+            "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+            "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+            "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+          },
+          "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+            "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+            "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+            "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+          },
+          "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+            "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+            "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+          },
+          "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+            "enabled": True or False, # Enable deblocker. The default is `false`.
+            "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+          },
+          "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+            "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+            "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+          },
+          "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+            "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+            "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+          },
+        },
+        "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+      },
+    ],
+    "manifests": [ # List of output manifests.
+      { # Manifest configuration.
+        "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+        "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+          "A String",
+        ],
+        "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+      },
+    ],
+    "muxStreams": [ # List of multiplexing settings for output streams.
+      { # Multiplexing settings for output stream.
+        "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+        "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+          "A String",
+        ],
+        "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+        "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+        "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+          "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+          "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+        },
+      },
+    ],
+    "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+      "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+    },
+    "overlays": [ # List of overlays on the output video, in descending Z-order.
+      { # Overlay configuration.
+        "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+          { # Animation types.
+            "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+              "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+            },
+            "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+              "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+              "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+              "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+            "animationStatic": { # Display static overlay object. # Display static overlay object.
+              "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+          },
+        ],
+        "image": { # Overlaid jpeg image. # Image overlay.
+          "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+          "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+            "x": 3.14, # Normalized x coordinate.
+            "y": 3.14, # Normalized y coordinate.
+          },
+          "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+        },
+      },
+    ],
+    "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+      "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+    },
+    "spriteSheets": [ # List of output sprite sheets.
+      { # Sprite sheet configuration.
+        "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+        "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+        "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+        "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+        "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+        "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+        "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+        "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+        "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+        "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+        "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+      },
+    ],
+  },
+  "name": "A String", # The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists job templates in the specified region.
+
+Args:
+  parent: string, Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, The filter expression, following the syntax outlined in https://google.aip.dev/160.
+  orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The `next_page_token` value returned from a previous List request, if any.
+  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 `TranscoderService.ListJobTemplates`.
+  "jobTemplates": [ # List of job templates in the specified region.
+    { # Transcoding job template resource.
+      "config": { # Job configuration # The configuration for this template.
+        "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+          { # Ad break.
+            "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+          },
+        ],
+        "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+          { # Edit atom.
+            "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+            "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+              "A String",
+            ],
+            "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+            "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+          },
+        ],
+        "elementaryStreams": [ # List of elementary streams.
+          { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+            "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+              "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+              "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+              "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+                "A String",
+              ],
+              "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+              "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+                { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+                  "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+                  "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+                  "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+                  "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+                  "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+                  "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+                },
+              ],
+              "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+            },
+            "key": "A String", # A unique key for this elementary stream.
+            "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+              "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+              "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+                { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+                  "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+                  "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+                  "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+                },
+              ],
+            },
+            "videoStream": { # Video stream resource. # Encoding of a video stream.
+              "h264": { # H264 codec settings. # H264 codec settings.
+                "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+                "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+                "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+                "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+                "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+                "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+                "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+                "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+                "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+                "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+                "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+                "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+                "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+                "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+                "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+                "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+                "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+                "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+                "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+                "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+              },
+              "h265": { # H265 codec settings. # H265 codec settings.
+                "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+                "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+                "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+                "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+                "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+                "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+                "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+                "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+                "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+                "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+                "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+                "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+                "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+                "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+                "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+                "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+                "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+                "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+                "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+              },
+              "vp9": { # VP9 codec settings. # VP9 codec settings.
+                "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+                "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+                "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+                "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+                "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+                "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+                "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+                "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+                "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+                "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+              },
+            },
+          },
+        ],
+        "inputs": [ # List of input assets stored in Cloud Storage.
+          { # Input asset.
+            "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+            "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+              "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+                "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+                "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+                "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+              },
+              "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+                "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+                "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+                "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+              },
+              "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+                "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+                "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+                "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+                "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+              },
+              "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+                "enabled": True or False, # Enable deblocker. The default is `false`.
+                "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+              },
+              "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+                "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+                "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+              },
+              "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+                "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+                "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+                "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+                "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+              },
+            },
+            "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+          },
+        ],
+        "manifests": [ # List of output manifests.
+          { # Manifest configuration.
+            "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+            "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+              "A String",
+            ],
+            "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+          },
+        ],
+        "muxStreams": [ # List of multiplexing settings for output streams.
+          { # Multiplexing settings for output stream.
+            "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+            "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+              "A String",
+            ],
+            "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+            "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+            "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+              "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+              "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+            },
+          },
+        ],
+        "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+          "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+        },
+        "overlays": [ # List of overlays on the output video, in descending Z-order.
+          { # Overlay configuration.
+            "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+              { # Animation types.
+                "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+                  "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+                },
+                "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+                  "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+                  "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+                  "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+                  "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                    "x": 3.14, # Normalized x coordinate.
+                    "y": 3.14, # Normalized y coordinate.
+                  },
+                },
+                "animationStatic": { # Display static overlay object. # Display static overlay object.
+                  "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+                  "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                    "x": 3.14, # Normalized x coordinate.
+                    "y": 3.14, # Normalized y coordinate.
+                  },
+                },
+              },
+            ],
+            "image": { # Overlaid jpeg image. # Image overlay.
+              "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+              "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+              "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+            },
+          },
+        ],
+        "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+          "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+        },
+        "spriteSheets": [ # List of output sprite sheets.
+          { # Sprite sheet configuration.
+            "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+            "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+            "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+            "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+            "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+            "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+            "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+            "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+            "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+            "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+            "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+          },
+        ],
+      },
+      "name": "A String", # The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`
+    },
+  ],
+  "nextPageToken": "A String", # The pagination token.
+  "unreachable": [ # List of regions that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ 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/transcoder_v1.projects.locations.jobs.html b/docs/dyn/transcoder_v1.projects.locations.jobs.html new file mode 100644 index 00000000000..6b131be79bf --- /dev/null +++ b/docs/dyn/transcoder_v1.projects.locations.jobs.html @@ -0,0 +1,1178 @@ + + + +

Transcoder API . projects . locations . jobs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a job in the specified region.

+

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

+

Deletes a job.

+

+ get(name, x__xgafv=None)

+

Returns the job data.

+

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

+

Lists jobs in the specified region.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a job in the specified region.
+
+Args:
+  parent: string, Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Transcoding job resource.
+  "config": { # Job configuration # The configuration for this job.
+    "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+      { # Ad break.
+        "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+      },
+    ],
+    "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+      { # Edit atom.
+        "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+        "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+          "A String",
+        ],
+        "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+        "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+      },
+    ],
+    "elementaryStreams": [ # List of elementary streams.
+      { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+        "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+          "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+          "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+          "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+            "A String",
+          ],
+          "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+              "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+              "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+              "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+            },
+          ],
+          "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+        },
+        "key": "A String", # A unique key for this elementary stream.
+        "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+          "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+            },
+          ],
+        },
+        "videoStream": { # Video stream resource. # Encoding of a video stream.
+          "h264": { # H264 codec settings. # H264 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "h265": { # H265 codec settings. # H265 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "vp9": { # VP9 codec settings. # VP9 codec settings.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+        },
+      },
+    ],
+    "inputs": [ # List of input assets stored in Cloud Storage.
+      { # Input asset.
+        "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+        "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+          "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+            "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+            "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+            "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+          },
+          "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+            "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+            "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+            "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+          },
+          "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+            "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+            "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+          },
+          "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+            "enabled": True or False, # Enable deblocker. The default is `false`.
+            "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+          },
+          "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+            "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+            "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+          },
+          "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+            "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+            "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+          },
+        },
+        "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+      },
+    ],
+    "manifests": [ # List of output manifests.
+      { # Manifest configuration.
+        "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+        "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+          "A String",
+        ],
+        "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+      },
+    ],
+    "muxStreams": [ # List of multiplexing settings for output streams.
+      { # Multiplexing settings for output stream.
+        "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+        "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+          "A String",
+        ],
+        "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+        "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+        "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+          "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+          "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+        },
+      },
+    ],
+    "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+      "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+    },
+    "overlays": [ # List of overlays on the output video, in descending Z-order.
+      { # Overlay configuration.
+        "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+          { # Animation types.
+            "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+              "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+            },
+            "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+              "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+              "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+              "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+            "animationStatic": { # Display static overlay object. # Display static overlay object.
+              "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+          },
+        ],
+        "image": { # Overlaid jpeg image. # Image overlay.
+          "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+          "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+            "x": 3.14, # Normalized x coordinate.
+            "y": 3.14, # Normalized y coordinate.
+          },
+          "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+        },
+      },
+    ],
+    "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+      "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+    },
+    "spriteSheets": [ # List of output sprite sheets.
+      { # Sprite sheet configuration.
+        "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+        "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+        "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+        "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+        "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+        "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+        "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+        "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+        "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+        "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+        "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. The time the job was created.
+  "endTime": "A String", # Output only. The time the transcoding finished.
+  "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). # Output only. An error object that describes the reason for the failure. This property is always present when `state` is `FAILED`.
+    "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.
+  },
+  "inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
+  "name": "A String", # The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}`
+  "outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
+  "startTime": "A String", # Output only. The time the transcoding started.
+  "state": "A String", # Output only. The current state of the job.
+  "templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
+  "ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Transcoding job resource.
+  "config": { # Job configuration # The configuration for this job.
+    "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+      { # Ad break.
+        "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+      },
+    ],
+    "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+      { # Edit atom.
+        "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+        "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+          "A String",
+        ],
+        "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+        "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+      },
+    ],
+    "elementaryStreams": [ # List of elementary streams.
+      { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+        "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+          "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+          "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+          "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+            "A String",
+          ],
+          "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+              "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+              "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+              "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+            },
+          ],
+          "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+        },
+        "key": "A String", # A unique key for this elementary stream.
+        "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+          "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+            },
+          ],
+        },
+        "videoStream": { # Video stream resource. # Encoding of a video stream.
+          "h264": { # H264 codec settings. # H264 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "h265": { # H265 codec settings. # H265 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "vp9": { # VP9 codec settings. # VP9 codec settings.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+        },
+      },
+    ],
+    "inputs": [ # List of input assets stored in Cloud Storage.
+      { # Input asset.
+        "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+        "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+          "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+            "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+            "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+            "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+          },
+          "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+            "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+            "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+            "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+          },
+          "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+            "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+            "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+          },
+          "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+            "enabled": True or False, # Enable deblocker. The default is `false`.
+            "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+          },
+          "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+            "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+            "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+          },
+          "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+            "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+            "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+          },
+        },
+        "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+      },
+    ],
+    "manifests": [ # List of output manifests.
+      { # Manifest configuration.
+        "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+        "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+          "A String",
+        ],
+        "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+      },
+    ],
+    "muxStreams": [ # List of multiplexing settings for output streams.
+      { # Multiplexing settings for output stream.
+        "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+        "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+          "A String",
+        ],
+        "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+        "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+        "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+          "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+          "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+        },
+      },
+    ],
+    "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+      "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+    },
+    "overlays": [ # List of overlays on the output video, in descending Z-order.
+      { # Overlay configuration.
+        "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+          { # Animation types.
+            "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+              "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+            },
+            "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+              "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+              "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+              "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+            "animationStatic": { # Display static overlay object. # Display static overlay object.
+              "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+          },
+        ],
+        "image": { # Overlaid jpeg image. # Image overlay.
+          "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+          "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+            "x": 3.14, # Normalized x coordinate.
+            "y": 3.14, # Normalized y coordinate.
+          },
+          "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+        },
+      },
+    ],
+    "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+      "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+    },
+    "spriteSheets": [ # List of output sprite sheets.
+      { # Sprite sheet configuration.
+        "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+        "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+        "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+        "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+        "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+        "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+        "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+        "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+        "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+        "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+        "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. The time the job was created.
+  "endTime": "A String", # Output only. The time the transcoding finished.
+  "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). # Output only. An error object that describes the reason for the failure. This property is always present when `state` is `FAILED`.
+    "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.
+  },
+  "inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
+  "name": "A String", # The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}`
+  "outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
+  "startTime": "A String", # Output only. The time the transcoding started.
+  "state": "A String", # Output only. The current state of the job.
+  "templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
+  "ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
+}
+
+ +
+ delete(name, allowMissing=None, x__xgafv=None) +
Deletes a job.
+
+Args:
+  name: string, Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}` (required)
+  allowMissing: boolean, If set to true, and the job is not found, the request will succeed but no action will be taken on the server.
+  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) +
Returns the job data.
+
+Args:
+  name: string, Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Transcoding job resource.
+  "config": { # Job configuration # The configuration for this job.
+    "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+      { # Ad break.
+        "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+      },
+    ],
+    "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+      { # Edit atom.
+        "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+        "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+          "A String",
+        ],
+        "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+        "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+      },
+    ],
+    "elementaryStreams": [ # List of elementary streams.
+      { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+        "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+          "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+          "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+          "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+            "A String",
+          ],
+          "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+              "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+              "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+              "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+            },
+          ],
+          "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+        },
+        "key": "A String", # A unique key for this elementary stream.
+        "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+          "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+          "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+            { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+              "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+              "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+              "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+            },
+          ],
+        },
+        "videoStream": { # Video stream resource. # Encoding of a video stream.
+          "h264": { # H264 codec settings. # H264 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "h265": { # H265 codec settings. # H265 codec settings.
+            "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+            "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+            "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+            "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+            "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+            "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+          "vp9": { # VP9 codec settings. # VP9 codec settings.
+            "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+            "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+            "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+            "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+            "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+            "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+            "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+            "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+            "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+            "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+          },
+        },
+      },
+    ],
+    "inputs": [ # List of input assets stored in Cloud Storage.
+      { # Input asset.
+        "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+        "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+          "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+            "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+            "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+            "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+          },
+          "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+            "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+            "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+            "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+          },
+          "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+            "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+            "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+          },
+          "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+            "enabled": True or False, # Enable deblocker. The default is `false`.
+            "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+          },
+          "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+            "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+            "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+          },
+          "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+            "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+            "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+            "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+            "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+          },
+        },
+        "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+      },
+    ],
+    "manifests": [ # List of output manifests.
+      { # Manifest configuration.
+        "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+        "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+          "A String",
+        ],
+        "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+      },
+    ],
+    "muxStreams": [ # List of multiplexing settings for output streams.
+      { # Multiplexing settings for output stream.
+        "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+        "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+          "A String",
+        ],
+        "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+        "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+        "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+          "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+          "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+        },
+      },
+    ],
+    "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+      "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+    },
+    "overlays": [ # List of overlays on the output video, in descending Z-order.
+      { # Overlay configuration.
+        "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+          { # Animation types.
+            "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+              "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+            },
+            "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+              "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+              "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+              "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+            "animationStatic": { # Display static overlay object. # Display static overlay object.
+              "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+              "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+            },
+          },
+        ],
+        "image": { # Overlaid jpeg image. # Image overlay.
+          "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+          "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+            "x": 3.14, # Normalized x coordinate.
+            "y": 3.14, # Normalized y coordinate.
+          },
+          "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+        },
+      },
+    ],
+    "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+      "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+    },
+    "spriteSheets": [ # List of output sprite sheets.
+      { # Sprite sheet configuration.
+        "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+        "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+        "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+        "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+        "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+        "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+        "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+        "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+        "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+        "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+        "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. The time the job was created.
+  "endTime": "A String", # Output only. The time the transcoding finished.
+  "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). # Output only. An error object that describes the reason for the failure. This property is always present when `state` is `FAILED`.
+    "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.
+  },
+  "inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
+  "name": "A String", # The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}`
+  "outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
+  "startTime": "A String", # Output only. The time the transcoding started.
+  "state": "A String", # Output only. The current state of the job.
+  "templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
+  "ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists jobs in the specified region.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, The filter expression, following the syntax outlined in https://google.aip.dev/160.
+  orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The `next_page_token` value returned from a previous List request, if any.
+  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 `TranscoderService.ListJobs`.
+  "jobs": [ # List of jobs in the specified region.
+    { # Transcoding job resource.
+      "config": { # Job configuration # The configuration for this job.
+        "adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
+          { # Ad break.
+            "startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
+          },
+        ],
+        "editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
+          { # Edit atom.
+            "endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
+            "inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
+              "A String",
+            ],
+            "key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
+            "startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
+          },
+        ],
+        "elementaryStreams": [ # List of elementary streams.
+          { # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
+            "audioStream": { # Audio stream resource. # Encoding of an audio stream.
+              "bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
+              "channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
+              "channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
+                "A String",
+              ],
+              "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
+              "mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+                { # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
+                  "atomKey": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
+                  "gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
+                  "inputChannel": 42, # Required. The zero-based index of the channel in the input audio stream.
+                  "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+                  "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+                  "outputChannel": 42, # Required. The zero-based index of the channel in the output audio stream.
+                },
+              ],
+              "sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
+            },
+            "key": "A String", # A unique key for this elementary stream.
+            "textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
+              "codec": "A String", # The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
+              "mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+                { # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
+                  "atomKey": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
+                  "inputKey": "A String", # Required. The `Input.key` that identifies the input file.
+                  "inputTrack": 42, # Required. The zero-based index of the track in the input file.
+                },
+              ],
+            },
+            "videoStream": { # Video stream resource. # Encoding of a video stream.
+              "h264": { # H264 codec settings. # H264 codec settings.
+                "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+                "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+                "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+                "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+                "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+                "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+                "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+                "entropyCoder": "A String", # The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
+                "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+                "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+                "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+                "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+                "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+                "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+                "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+                "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+                "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
+                "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+                "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+                "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+              },
+              "h265": { # H265 codec settings. # H265 codec settings.
+                "allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
+                "aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
+                "bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
+                "bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
+                "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
+                "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+                "enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
+                "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+                "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+                "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+                "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+                "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+                "preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+                "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+                "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+                "tune": "A String", # Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
+                "vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
+                "vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
+                "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+              },
+              "vp9": { # VP9 codec settings. # VP9 codec settings.
+                "bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
+                "crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
+                "frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
+                "gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
+                "gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
+                "heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
+                "pixelFormat": "A String", # Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
+                "profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
+                "rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
+                "widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
+              },
+            },
+          },
+        ],
+        "inputs": [ # List of input assets stored in Cloud Storage.
+          { # Input asset.
+            "key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
+            "preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
+              "audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
+                "highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
+                "lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
+                "lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
+              },
+              "color": { # Color preprocessing configuration. # Color preprocessing configuration.
+                "brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
+                "contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
+                "saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
+              },
+              "crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
+                "bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
+                "leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
+                "rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
+                "topPixels": 42, # The number of pixels to crop from the top. The default is 0.
+              },
+              "deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
+                "enabled": True or False, # Enable deblocker. The default is `false`.
+                "strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
+              },
+              "denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
+                "strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
+                "tune": "A String", # Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`
+              },
+              "pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
+                "bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
+                "leftPixels": 42, # The number of pixels to add to the left. The default is 0.
+                "rightPixels": 42, # The number of pixels to add to the right. The default is 0.
+                "topPixels": 42, # The number of pixels to add to the top. The default is 0.
+              },
+            },
+            "uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
+          },
+        ],
+        "manifests": [ # List of output manifests.
+          { # Manifest configuration.
+            "fileName": "A String", # The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
+            "muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
+              "A String",
+            ],
+            "type": "A String", # Required. Type of the manifest, can be `HLS` or `DASH`.
+          },
+        ],
+        "muxStreams": [ # List of multiplexing settings for output streams.
+          { # Multiplexing settings for output stream.
+            "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`
+            "elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
+              "A String",
+            ],
+            "fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
+            "key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
+            "segmentSettings": { # Segment settings for `ts`, `fmp4` and `vtt`. # Segment settings for `ts`, `fmp4` and `vtt`.
+              "individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
+              "segmentDuration": "A String", # Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
+            },
+          },
+        ],
+        "output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
+          "uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
+        },
+        "overlays": [ # List of overlays on the output video, in descending Z-order.
+          { # Overlay configuration.
+            "animations": [ # List of Animations. The list should be chronological, without any time overlap.
+              { # Animation types.
+                "animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
+                  "startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
+                },
+                "animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
+                  "endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
+                  "fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
+                  "startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
+                  "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                    "x": 3.14, # Normalized x coordinate.
+                    "y": 3.14, # Normalized y coordinate.
+                  },
+                },
+                "animationStatic": { # Display static overlay object. # Display static overlay object.
+                  "startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
+                  "xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
+                    "x": 3.14, # Normalized x coordinate.
+                    "y": 3.14, # Normalized y coordinate.
+                  },
+                },
+              },
+            ],
+            "image": { # Overlaid jpeg image. # Image overlay.
+              "alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
+              "resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
+                "x": 3.14, # Normalized x coordinate.
+                "y": 3.14, # Normalized y coordinate.
+              },
+              "uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+            },
+          },
+        ],
+        "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
+          "topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
+        },
+        "spriteSheets": [ # List of output sprite sheets.
+          { # Sprite sheet configuration.
+            "columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
+            "endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
+            "filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
+            "format": "A String", # Format type. The default is `jpeg`. Supported formats: - `jpeg`
+            "interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
+            "quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
+            "rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
+            "spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
+            "spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
+            "startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
+            "totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
+          },
+        ],
+      },
+      "createTime": "A String", # Output only. The time the job was created.
+      "endTime": "A String", # Output only. The time the transcoding finished.
+      "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). # Output only. An error object that describes the reason for the failure. This property is always present when `state` is `FAILED`.
+        "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.
+      },
+      "inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
+      "name": "A String", # The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}`
+      "outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
+      "startTime": "A String", # Output only. The time the transcoding started.
+      "state": "A String", # Output only. The current state of the job.
+      "templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
+      "ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
+    },
+  ],
+  "nextPageToken": "A String", # The pagination token.
+  "unreachable": [ # List of regions that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ 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/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html index 73f3305bd5f..869e571b943 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -150,6 +150,9 @@

Method Details

{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -258,6 +261,9 @@

Method Details

{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -342,6 +348,9 @@

Method Details

"cloneJobs": [ # Output only. The list of clone jobs response. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html index 7d65a2e418d..1d22e066aa8 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -150,6 +150,9 @@

Method Details

{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -260,6 +263,9 @@

Method Details

{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -346,6 +352,9 @@

Method Details

"cutoverJobs": [ # Output only. The list of cutover jobs response. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 9d7b5d5aec0..8132611c3fc 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -134,6 +134,9 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -211,6 +214,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -275,6 +281,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -472,6 +481,9 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -549,6 +561,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -613,6 +628,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -710,6 +728,9 @@

Method Details

"migratingVms": [ # Output only. The list of Migrating VMs response. { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -787,6 +808,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -851,6 +875,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -952,6 +979,9 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -1029,6 +1059,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -1093,6 +1126,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html index 61345ff5c36..9bd1a4ed898 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -150,6 +150,9 @@

Method Details

{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -365,6 +368,9 @@

Method Details

{ # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -556,6 +562,9 @@

Method Details

"cloneJobs": [ # Output only. The list of clone jobs response. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html index 2c93961aedf..079695a0025 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -150,6 +150,9 @@

Method Details

{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -368,6 +371,9 @@

Method Details

{ # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -562,6 +568,9 @@

Method Details

"cutoverJobs": [ # Output only. The list of cutover jobs response. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index 9cf0b8c55b9..c85a703cad0 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -134,6 +134,9 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -266,6 +269,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -437,6 +443,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -795,6 +804,9 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -927,6 +939,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -1098,6 +1113,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -1356,6 +1374,9 @@

Method Details

"migratingVms": [ # Output only. The list of Migrating VMs response. { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -1488,6 +1509,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -1659,6 +1683,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -1921,6 +1948,9 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "computeEngineTargetDefaults": { # ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. # Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # Output only. The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -2053,6 +2083,9 @@

Method Details

"recentCloneJobs": [ # Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CloneJob describes the process of creating a clone of a MigratingVM to the requested target based on the latest successful uploaded snapshots. While the migration cycles of a MigratingVm take place, it is possible to verify the uploaded VM can be started in the cloud, by creating a clone. The clone can be created without any downtime, and it is created using the latest snapshots which are already in the cloud. The cloneJob is only responsible for its work, not its products, which means once it is finished, it will never touch the instance it created. It will only delete it in case of the CloneJob being cancelled or upon failure to clone. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. @@ -2224,6 +2257,9 @@

Method Details

"recentCutoverJobs": [ # Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. { # CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. "computeEngineTargetDetails": { # ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. # Output only. Details of the target VM in Compute Engine. + "additionalLicenses": [ # Additional licenses to assign to the VM. + "A String", + ], "appliedLicense": { # AppliedLicense holds the license data returned by adaptation module report. # The OS license returned from the adaptation module report. "osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. diff --git a/docs/start.md b/docs/start.md index 9207620a8c2..700b7684162 100644 --- a/docs/start.md +++ b/docs/start.md @@ -149,5 +149,5 @@ Use the [APIs Explorer](https://developers.google.com/apis-explorer/) to browse ## Library reference documentation -[Core library documentation](http://googleapis.github.io/google-api-python-client/docs/epy/index.html). -and [Library reference documentation by API](dyn/index.md). is available. +[Core library documentation](http://googleapis.github.io/google-api-python-client/docs/epy/index.html) +and [Library reference documentation by API](dyn/index.md) are available. diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index 30f3032308c..2fa29d3dadd 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, - "revision": "20211203", + "revision": "20211230", "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 7b43b912cb7..ac4bd11f930 100644 --- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json +++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json @@ -754,7 +754,7 @@ } } }, - "revision": "20211130", + "revision": "20220103", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalSettings": { diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index d8406e0599f..32f0ec1c3c7 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -108,7 +108,7 @@ "accessPolicies": { "methods": { "create": { - "description": "Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.", + "description": "Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto.", "flatPath": "v1/accessPolicies", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.create", @@ -126,7 +126,7 @@ ] }, "delete": { - "description": "Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.", + "description": "Deletes an access policy based on the resource name. The long-running operation has a successful status after the access policy is removed from long-lasting storage.", "flatPath": "v1/accessPolicies/{accessPoliciesId}", "httpMethod": "DELETE", "id": "accesscontextmanager.accessPolicies.delete", @@ -151,7 +151,7 @@ ] }, "get": { - "description": "Get an AccessPolicy by name.", + "description": "Returns an access policy based on the name.", "flatPath": "v1/accessPolicies/{accessPoliciesId}", "httpMethod": "GET", "id": "accesscontextmanager.accessPolicies.get", @@ -175,8 +175,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the IAM policy for the specified Access Context Manager access policy.", + "flatPath": "v1/accessPolicies/{accessPoliciesId}:getIamPolicy", + "httpMethod": "POST", + "id": "accesscontextmanager.accessPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^accessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { - "description": "List all AccessPolicies under a container.", + "description": "Lists all access policies in an organization.", "flatPath": "v1/accessPolicies", "httpMethod": "GET", "id": "accesscontextmanager.accessPolicies.list", @@ -208,7 +236,7 @@ ] }, "patch": { - "description": "Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.", + "description": "Updates an access policy. The long-running operation from this RPC has a successful status after the changes to the access policy propagate to long-lasting storage.", "flatPath": "v1/accessPolicies/{accessPoliciesId}", "httpMethod": "PATCH", "id": "accesscontextmanager.accessPolicies.patch", @@ -240,13 +268,69 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "description": "Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy.", + "flatPath": "v1/accessPolicies/{accessPoliciesId}:setIamPolicy", + "httpMethod": "POST", + "id": "accesscontextmanager.accessPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^accessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.", + "flatPath": "v1/accessPolicies/{accessPoliciesId}:testIamPermissions", + "httpMethod": "POST", + "id": "accesscontextmanager.accessPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^accessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "accessLevels": { "methods": { "create": { - "description": "Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.", + "description": "Creates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.accessLevels.create", @@ -274,7 +358,7 @@ ] }, "delete": { - "description": "Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.", + "description": "Deletes an access level based on the resource name. The long-running operation from this RPC has a successful status after the access level has been removed from long-lasting storage.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}", "httpMethod": "DELETE", "id": "accesscontextmanager.accessPolicies.accessLevels.delete", @@ -299,7 +383,7 @@ ] }, "get": { - "description": "Get an Access Level by resource name.", + "description": "Gets an access level based on the resource name.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}", "httpMethod": "GET", "id": "accesscontextmanager.accessPolicies.accessLevels.get", @@ -339,7 +423,7 @@ ] }, "list": { - "description": "List all Access Levels for an access policy.", + "description": "Lists all access levels for an access policy.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels", "httpMethod": "GET", "id": "accesscontextmanager.accessPolicies.accessLevels.list", @@ -390,7 +474,7 @@ ] }, "patch": { - "description": "Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.", + "description": "Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}", "httpMethod": "PATCH", "id": "accesscontextmanager.accessPolicies.accessLevels.patch", @@ -424,7 +508,7 @@ ] }, "replaceAll": { - "description": "Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.", + "description": "Replaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing access levels are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing access levels contained in existing service perimeters result in an error.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels:replaceAll", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.accessLevels.replaceAll", @@ -450,13 +534,41 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "testIamPermissions": { + "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.", + "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}:testIamPermissions", + "httpMethod": "POST", + "id": "accesscontextmanager.accessPolicies.accessLevels.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^accessPolicies/[^/]+/accessLevels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, "servicePerimeters": { "methods": { "commit": { - "description": "Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its `spec` field to that Service Perimeter's `status` field. Only Service Perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will be cleared after a successful commit operation.", + "description": "Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its `spec` field to the `status` field of the service perimeter. Only service perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are cleared after a successful commit operation.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters:commit", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.servicePerimeters.commit", @@ -484,7 +596,7 @@ ] }, "create": { - "description": "Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.", + "description": "Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.servicePerimeters.create", @@ -512,7 +624,7 @@ ] }, "delete": { - "description": "Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.", + "description": "Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}", "httpMethod": "DELETE", "id": "accesscontextmanager.accessPolicies.servicePerimeters.delete", @@ -537,7 +649,7 @@ ] }, "get": { - "description": "Get a Service Perimeter by resource name.", + "description": "Gets a service perimeter based on the resource name.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}", "httpMethod": "GET", "id": "accesscontextmanager.accessPolicies.servicePerimeters.get", @@ -562,7 +674,7 @@ ] }, "list": { - "description": "List all Service Perimeters for an access policy.", + "description": "Lists all service perimeters for an access policy.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters", "httpMethod": "GET", "id": "accesscontextmanager.accessPolicies.servicePerimeters.list", @@ -598,7 +710,7 @@ ] }, "patch": { - "description": "Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.", + "description": "Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}", "httpMethod": "PATCH", "id": "accesscontextmanager.accessPolicies.servicePerimeters.patch", @@ -632,7 +744,7 @@ ] }, "replaceAll": { - "description": "Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse.", + "description": "Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters:replaceAll", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.servicePerimeters.replaceAll", @@ -658,6 +770,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "testIamPermissions": { + "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.", + "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}:testIamPermissions", + "httpMethod": "POST", + "id": "accesscontextmanager.accessPolicies.servicePerimeters.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^accessPolicies/[^/]+/servicePerimeters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -791,7 +931,7 @@ "gcpUserAccessBindings": { "methods": { "create": { - "description": "Creates a GcpUserAccessBinding. If the client specifies a name, the server will ignore it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.", + "description": "Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.", "flatPath": "v1/organizations/{organizationsId}/gcpUserAccessBindings", "httpMethod": "POST", "id": "accesscontextmanager.organizations.gcpUserAccessBindings.create", @@ -943,7 +1083,7 @@ } } }, - "revision": "20211112", + "revision": "20211213", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -995,6 +1135,13 @@ "description": "Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`", "type": "string" }, + "scopes": { + "description": "The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[\"folders/123\"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes \"folders/123\" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`", + "items": { + "type": "string" + }, + "type": "array" + }, "title": { "description": "Required. Human readable title. Does not affect behavior.", "type": "string" @@ -1020,6 +1167,54 @@ }, "type": "object" }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, "BasicLevel": { "description": "`BasicLevel` is an `AccessLevel` using a set of recommended features.", "id": "BasicLevel", @@ -1046,6 +1241,28 @@ }, "type": "object" }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1318,6 +1535,29 @@ "properties": {}, "type": "object" }, + "GetIamPolicyRequest": { + "description": "Request message for `GetIamPolicy` method.", + "id": "GetIamPolicyRequest", + "properties": { + "options": { + "$ref": "GetPolicyOptions", + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." + } + }, + "type": "object" + }, + "GetPolicyOptions": { + "description": "Encapsulates settings provided to GetIamPolicy.", + "id": "GetPolicyOptions", + "properties": { + "requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "IngressFrom": { "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.", "id": "IngressFrom", @@ -1583,6 +1823,37 @@ }, "type": "object" }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ReplaceAccessLevelsRequest": { "description": "A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically.", "id": "ReplaceAccessLevelsRequest", @@ -1736,6 +2007,22 @@ }, "type": "object" }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1763,6 +2050,34 @@ }, "type": "object" }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VpcAccessibleServices": { "description": "Specifies how APIs are allowed to communicate within the Service Perimeter.", "id": "VpcAccessibleServices", diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json index 95984ec1934..d1b4e6310de 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json @@ -609,7 +609,7 @@ } } }, - "revision": "20211112", + "revision": "20211213", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index 681d354b18c..b32be6e5e68 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -2568,7 +2568,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { diff --git a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json index 0db1f578e8e..4ded6a0b64c 100644 --- a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json @@ -272,7 +272,7 @@ } } }, - "revision": "20211116", + "revision": "20211221", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 7e997b2e4cf..0e90eeff7ec 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -432,7 +432,7 @@ "type": "string" }, "orgUnitPath": { - "description": "The full path of the organizational unit or its unique ID.", + "description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.", "location": "query", "type": "string" }, @@ -1935,7 +1935,7 @@ ] }, "list": { - "description": "Retrieves a paginated list of all mobile devices for an account.", + "description": "Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead.", "flatPath": "admin/directory/v1/customer/{customerId}/devices/mobile", "httpMethod": "GET", "id": "directory.mobiledevices.list", @@ -2051,7 +2051,7 @@ "type": "string" }, "orgUnitPath": { - "description": "The full path of the organizational unit or its unique ID.", + "description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -2080,7 +2080,7 @@ "type": "string" }, "orgUnitPath": { - "description": "The full path of the organizational unit or its unique ID.", + "description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -2184,7 +2184,7 @@ "type": "string" }, "orgUnitPath": { - "description": "The full path of the organizational unit or its unique ID.", + "description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -2219,7 +2219,7 @@ "type": "string" }, "orgUnitPath": { - "description": "The full path of the organizational unit or its unique ID.", + "description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -4402,7 +4402,7 @@ } } }, - "revision": "20211116", + "revision": "20211221", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5183,6 +5183,10 @@ "description": "The device's order number. Only devices directly purchased from Google have an order number.", "type": "string" }, + "orgUnitId": { + "description": "The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API, and this will be supported in the future.", + "type": "string" + }, "orgUnitPath": { "description": "The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).", "type": "string" @@ -7352,11 +7356,15 @@ "id": "UserLanguage", "properties": { "customLanguage": { - "description": "Other language. User can provide own language name if there is no corresponding Google III language code. If this is set LanguageCode can't be set", + "description": "Other language. User can provide their own language name if there is no corresponding ISO 639 language code. If this is set, `languageCode` can't be set.", "type": "string" }, "languageCode": { - "description": "Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.", + "description": "ISO 639 string representation of a language. See [Language Codes](/admin-sdk/directory/v1/languages) for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. Illegal values cause `SchemaException`. If this is set, `customLanguage` can't be set.", + "type": "string" + }, + "preference": { + "description": "Optional. If present, controls whether the specified `languageCode` is the user's preferred language. If `customLanguage` is set, this can't be set. Allowed values are `preferred` and `not_preferred`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index 517ee5bfb0a..763cd190a6e 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -164,9 +164,9 @@ "The Jamboard activity reports return information about various Jamboard activity events.", "The Login application's activity reports return account information about different types of Login activity events.", "The Meet Audit activity report returns information about different types of Meet Audit activity events.", - "The Mobile Audit activity report return information about different types of Mobile Audit activity events.", - "The Rules activity report return information about different types of Rules activity events.", - "The SAML activity report return information about different types of SAML activity events.", + "The Device Audit activity report returns information about different types of Device Audit activity events.", + "The Rules activity report returns information about different types of Rules activity events.", + "The SAML activity report returns information about different types of SAML activity events.", "The Token application's activity reports return account information about different types of Token activity events.", "The User Accounts application's activity reports return account information about different types of User Accounts activity events.", "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.", @@ -303,9 +303,9 @@ "The Jamboard activity reports return information about various Jamboard activity events.", "The Login application's activity reports return account information about different types of Login activity events.", "The Meet Audit activity report returns information about different types of Meet Audit activity events.", - "The Mobile Audit activity report return information about different types of Mobile Audit activity events.", - "The Rules activity report return information about different types of Rules activity events.", - "The SAML activity report return information about different types of SAML activity events.", + "The Device Audit activity report returns information about different types of Device Audit activity events.", + "The Rules activity report returns information about different types of Rules activity events.", + "The SAML activity report returns information about different types of SAML activity events.", "The Token application's activity reports return account information about different types of Token activity events.", "The User Accounts application's activity reports return account information about different types of User Accounts activity events.", "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.", @@ -486,15 +486,7 @@ "type": "string" }, "entityKey": { - "description": "Represents the key of the object to filter the data with.", - "enum": [ - "all", - "entityKey" - ], - "enumDescriptions": [ - "Returns activity events for all users.", - "Represents an app-specific identifier for the entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides." - ], + "description": "Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides.", "location": "path", "required": true, "type": "string" @@ -631,7 +623,7 @@ } } }, - "revision": "20211116", + "revision": "20211221", "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 bbe982b98ae..ce5f50d6d83 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -321,7 +321,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index aa0ded19d29..a4dbec55c96 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -321,7 +321,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "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 index fff74d04f92..8689a5c47c2 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1567,7 +1567,7 @@ } } }, - "revision": "20211203", + "revision": "20211209", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index 0501cdb1c73..4ded1eb6628 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20211130", + "revision": "20211214", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AccountSuspensionDetails": { @@ -770,6 +770,14 @@ "description": "Link to the outage event in Google Workspace Status Dashboard", "type": "string" }, + "incidentTrackingId": { + "description": "Incident tracking ID.", + "type": "string" + }, + "mergeInfo": { + "$ref": "MergeInfo", + "description": "Indicates new alert details under which the outage is communicated. Only populated when Status is MERGED." + }, "nextUpdateTime": { "description": "Timestamp by which the next update is expected to arrive.", "format": "google-datetime", @@ -793,13 +801,19 @@ "STATUS_UNSPECIFIED", "NEW", "ONGOING", - "RESOLVED" + "RESOLVED", + "FALSE_POSITIVE", + "PARTIALLY_RESOLVED", + "MERGED" ], "enumDescriptions": [ "Status is unspecified.", "The incident has just been reported.", "The incident is ongoing.", - "The incident has been resolved." + "The incident has been resolved.", + "Further assessment indicated no customer impact.", + "The incident has been partially resolved.", + "The incident was merged into a parent." ], "type": "string" } @@ -1270,6 +1284,21 @@ }, "type": "object" }, + "MergeInfo": { + "description": "New alert tracking numbers.", + "id": "MergeInfo", + "properties": { + "newAlertId": { + "description": "New alert ID. Reference the [google.apps.alertcenter.Alert] with this ID for the current state.", + "type": "string" + }, + "newIncidentTrackingId": { + "description": "The new tracking ID from the parent incident.", + "type": "string" + } + }, + "type": "object" + }, "Notification": { "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).", "id": "Notification", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 8c1b27cba8f..bad26d4d87f 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -3274,7 +3274,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccount": { @@ -3873,6 +3873,23 @@ "description": "Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.", "type": "string" }, + "restrictedMetricType": { + "description": "Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.", + "items": { + "enum": [ + "RESTRICTED_METRIC_TYPE_UNSPECIFIED", + "COST_DATA", + "REVENUE_DATA" + ], + "enumDescriptions": [ + "Type unknown or unspecified.", + "Metric reports cost data.", + "Metric reports revenue data." + ], + "type": "string" + }, + "type": "array" + }, "scope": { "description": "Required. Immutable. The scope of this custom metric.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index d50e82a4b57..4d80e747336 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -313,7 +313,7 @@ } } }, - "revision": "20211202", + "revision": "20211230", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { @@ -621,7 +621,7 @@ "type": "object" }, "Dimension": { - "description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be \"Paris\" or \"New York\". Requests are allowed up to 9 dimensions.", + "description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be \"Paris\" or \"New York\". Requests are allowed up to 9 dimensions.", "id": "Dimension", "properties": { "dimensionExpression": { @@ -799,7 +799,7 @@ }, "filter": { "$ref": "Filter", - "description": "A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics." + "description": "A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics." }, "notExpression": { "$ref": "FilterExpression", @@ -1343,6 +1343,10 @@ "$ref": "SchemaRestrictionResponse", "description": "Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388)." }, + "subjectToThresholding": { + "description": "If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357).", + "type": "boolean" + }, "timeZone": { "description": "The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example \"America/New_York\" or \"Asia/Tokyo\".", "type": "string" @@ -1685,7 +1689,7 @@ }, "metricFilter": { "$ref": "FilterExpression", - "description": "The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter." + "description": "The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter." }, "metrics": { "description": "The metrics requested and displayed.", @@ -1822,8 +1826,8 @@ "Begins with the string value.", "Ends with the string value.", "Contains the string value.", - "Full regular expression match with the string value.", - "Partial regular expression match with the string value." + "Full match for the regular expression with the string value.", + "Partial match for the regular expression with the string value." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index 53cd9bd6aad..3b51eefb55e 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -825,7 +825,7 @@ } } }, - "revision": "20211203", + "revision": "20211214", "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 d2e899eb57e..d13fbdae602 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2610,7 +2610,7 @@ } } }, - "revision": "20211130", + "revision": "20211214", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 3ce828f59dc..d766dadb37e 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -3040,7 +3040,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "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 dfe44a6263d..5fe5cf35a6d 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20211201", + "revision": "20211208", "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 06447f1d117..5ebb08c8b28 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20211110", + "revision": "20211208", "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 b463c00b9cb..c0aadcf72ef 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -2715,6 +2715,34 @@ }, "balance": { "methods": { + "adjust": { + "description": "Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.", + "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust", + "httpMethod": "POST", + "id": "apigee.organizations.developers.balance.adjust", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`", + "location": "path", + "pattern": "^organizations/[^/]+/developers/[^/]+/balance$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:adjust", + "request": { + "$ref": "GoogleCloudApigeeV1AdjustDeveloperBalanceRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1DeveloperBalance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "credit": { "description": "Credits the account balance for the developer.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/balance:credit", @@ -7412,7 +7440,7 @@ } } }, - "revision": "20211201", + "revision": "20211209", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -7557,6 +7585,17 @@ }, "type": "object" }, + "GoogleCloudApigeeV1AdjustDeveloperBalanceRequest": { + "description": "Request for AdjustDeveloperBalance.", + "id": "GoogleCloudApigeeV1AdjustDeveloperBalanceRequest", + "properties": { + "adjustment": { + "$ref": "GoogleTypeMoney", + "description": "* A positive value of `adjustment` means that that the API provider wishes to adjust the balance for an over-charged developer i.e. the balance of the developer will increase. * A negative value of `adjustment` means that that the API provider wishes to adjust the balance for an under-charged developer i.e. the balance of the developer will decrease." + } + }, + "type": "object" + }, "GoogleCloudApigeeV1AdvancedApiOpsConfig": { "description": "Configuration for the Advanced API Ops add-on.", "id": "GoogleCloudApigeeV1AdvancedApiOpsConfig", @@ -7769,7 +7808,7 @@ "type": "string" }, "status": { - "description": "Status of the API product.", + "description": "Status of the API product. Valid values are `approved` or `revoked`.", "type": "string" } }, @@ -11140,8 +11179,12 @@ "description": "Name of the Apigee organization.", "type": "string" }, + "projectId": { + "description": "GCP project associated with the Apigee organization", + "type": "string" + }, "projectIds": { - "description": "List of GCP projects associated with the Apigee organization.", + "description": "DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a single project.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index c1e47427a0f..170abb1644e 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -424,7 +424,7 @@ } } }, - "revision": "20211112", + "revision": "20211215", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index f77092fe8b3..446a32e823b 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1595,7 +1595,7 @@ } } }, - "revision": "20211115", + "revision": "20211208", "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 0aa5005d1bb..6e028b12750 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -887,7 +887,7 @@ } } }, - "revision": "20211129", + "revision": "20211208", "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 3b2980eb591..42a5a5f1b2a 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1595,7 +1595,7 @@ } } }, - "revision": "20211129", + "revision": "20211208", "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 a2fe54f3185..95376e0515b 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -586,7 +586,7 @@ } } }, - "revision": "20211203", + "revision": "20211230", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 635610d69dd..088059411ff 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -283,7 +283,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index 4bf4cd6c6d5..bd0d9ae7097 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -224,7 +224,7 @@ ], "parameters": { "parent": { - "description": "The name of the parent resource where the repository will be created.", + "description": "Required. The name of the parent resource where the repository will be created.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -257,7 +257,7 @@ ], "parameters": { "name": { - "description": "The name of the repository to delete.", + "description": "Required. The name of the repository to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", "required": true, @@ -282,7 +282,7 @@ ], "parameters": { "name": { - "description": "The name of the repository to retrieve.", + "description": "Required. The name of the repository to retrieve.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", "required": true, @@ -351,7 +351,7 @@ "type": "string" }, "parent": { - "description": "The name of the parent resource whose repositories will be listed.", + "description": "Required. The name of the parent resource whose repositories will be listed.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -544,7 +544,7 @@ ], "parameters": { "name": { - "description": "The name of the package to delete.", + "description": "Required. The name of the package to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", "required": true, @@ -569,7 +569,7 @@ ], "parameters": { "name": { - "description": "The name of the package to retrieve.", + "description": "Required. The name of the package to retrieve.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", "required": true, @@ -606,7 +606,7 @@ "type": "string" }, "parent": { - "description": "The name of the parent resource whose packages will be listed.", + "description": "Required. The name of the parent resource whose packages will be listed.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", "required": true, @@ -929,7 +929,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -1448,7 +1448,6 @@ "DOCKER", "MAVEN", "NPM", - "PYPI", "APT", "YUM", "PYTHON" @@ -1458,7 +1457,6 @@ "Docker package format.", "Maven package format.", "NPM package format.", - "PyPI package format. Deprecated, use PYTHON instead.", "APT package format.", "YUM package format.", "Python package format." diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index c5f1d483838..2eeeb2799f8 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -1143,7 +1143,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 9a4e1f1b016..5e7a344c616 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -351,7 +351,7 @@ } } }, - "revision": "20211129", + "revision": "20211213", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": { @@ -466,10 +466,29 @@ "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", "type": "string" }, + "enableSovereignControls": { + "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", + "type": "boolean" + }, "etag": { "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", "type": "string" }, + "kajEnrollmentState": { + "description": "Output only. Represents the KAJ enrollment state of the given workload.", + "enum": [ + "KAJ_ENROLLMENT_STATE_UNSPECIFIED", + "KAJ_ENROLLMENT_STATE_PENDING", + "KAJ_ENROLLMENT_STATE_COMPLETE" + ], + "enumDescriptions": [ + "Default State for KAJ Enrollment.", + "Pending State for KAJ Enrollment.", + "Complete State for KAJ Enrollment." + ], + "readOnly": true, + "type": "string" + }, "kmsSettings": { "$ref": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings", "description": "Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes." @@ -503,6 +522,11 @@ }, "readOnly": true, "type": "array" + }, + "saaEnrollmentResponse": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse", + "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.", + "readOnly": true } }, "type": "object" @@ -538,12 +562,14 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", + "CONSUMER_FOLDER", "ENCRYPTION_KEYS_PROJECT", "KEYRING" ], "enumDescriptions": [ "Unknown resource type.", - "Consumer project.", + "Consumer project. AssuredWorkloads Projects are no longer supported. This field will be ignored only in CreateWorkload requests. ListWorkloads and GetWorkload will continue to provide projects information. Use CONSUMER_FOLDER instead.", + "Consumer Folder.", "Consumer project containing encryption keys.", "Keyring resource that hosts encryption keys." ], @@ -569,12 +595,14 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", + "CONSUMER_FOLDER", "ENCRYPTION_KEYS_PROJECT", "KEYRING" ], "enumDescriptions": [ "Unknown resource type.", - "Consumer project.", + "Consumer project. AssuredWorkloads Projects are no longer supported. This field will be ignored only in CreateWorkload requests. ListWorkloads and GetWorkload will continue to provide projects information. Use CONSUMER_FOLDER instead.", + "Consumer Folder.", "Consumer project containing encryption keys.", "Keyring resource that hosts encryption keys." ], @@ -583,6 +611,48 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse": { + "description": "Signed Access Approvals (SAA) enrollment response.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse", + "properties": { + "setupErrors": { + "description": "Indicates SAA enrollment setup error if any.", + "items": { + "enum": [ + "SETUP_ERROR_UNSPECIFIED", + "ERROR_INVALID_BASE_SETUP", + "ERROR_MISSING_EXTERNAL_SIGNING_KEY", + "ERROR_NOT_ALL_SERVICES_ENROLLED", + "ERROR_SETUP_CHECK_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Invalid states for all customers, to be redirected to AA UI for additional details.", + "Returned when there is not an EKM key configured.", + "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", + "Returned when exception was encountered during evaluation of other criteria." + ], + "type": "string" + }, + "type": "array" + }, + "setupStatus": { + "description": "Indicates SAA enrollment status of a given workload.", + "enum": [ + "SETUP_STATE_UNSPECIFIED", + "STATUS_PENDING", + "STATUS_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "SAA enrollment pending.", + "SAA enrollment comopleted." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata": { "description": "Operation metadata to give request details of CreateWorkload.", "id": "GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata", @@ -688,6 +758,10 @@ "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", "type": "string" }, + "enableSovereignControls": { + "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", + "type": "boolean" + }, "etag": { "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", "type": "string" @@ -704,6 +778,21 @@ "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings", "description": "Required. Input only. Immutable. Settings specific to resources needed for IL4." }, + "kajEnrollmentState": { + "description": "Output only. Represents the KAJ enrollment state of the given workload.", + "enum": [ + "KAJ_ENROLLMENT_STATE_UNSPECIFIED", + "KAJ_ENROLLMENT_STATE_PENDING", + "KAJ_ENROLLMENT_STATE_COMPLETE" + ], + "enumDescriptions": [ + "Default State for KAJ Enrollment.", + "Pending State for KAJ Enrollment.", + "Complete State for KAJ Enrollment." + ], + "readOnly": true, + "type": "string" + }, "kmsSettings": { "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", "description": "Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes." @@ -737,6 +826,11 @@ }, "readOnly": true, "type": "array" + }, + "saaEnrollmentResponse": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse", + "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.", + "readOnly": true } }, "type": "object" @@ -865,6 +959,48 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse": { + "description": "Signed Access Approvals (SAA) enrollment response.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse", + "properties": { + "setupErrors": { + "description": "Indicates SAA enrollment setup error if any.", + "items": { + "enum": [ + "SETUP_ERROR_UNSPECIFIED", + "ERROR_INVALID_BASE_SETUP", + "ERROR_MISSING_EXTERNAL_SIGNING_KEY", + "ERROR_NOT_ALL_SERVICES_ENROLLED", + "ERROR_SETUP_CHECK_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Invalid states for all customers, to be redirected to AA UI for additional details.", + "Returned when there is not an EKM key configured.", + "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", + "Returned when exception was encountered during evaluation of other criteria." + ], + "type": "string" + }, + "type": "array" + }, + "setupStatus": { + "description": "Indicates SAA enrollment status of a given workload.", + "enum": [ + "SETUP_STATE_UNSPECIFIED", + "STATUS_PENDING", + "STATUS_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "SAA enrollment pending.", + "SAA enrollment comopleted." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata": { "description": "Operation metadata to give request details of CreateWorkload.", "id": "GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata", @@ -970,6 +1106,10 @@ "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", "type": "string" }, + "enableSovereignControls": { + "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", + "type": "boolean" + }, "etag": { "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", "type": "string" @@ -986,6 +1126,21 @@ "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadIL4Settings", "description": "Required. Input only. Immutable. Settings specific to resources needed for IL4." }, + "kajEnrollmentState": { + "description": "Output only. Represents the KAJ enrollment state of the given workload.", + "enum": [ + "KAJ_ENROLLMENT_STATE_UNSPECIFIED", + "KAJ_ENROLLMENT_STATE_PENDING", + "KAJ_ENROLLMENT_STATE_COMPLETE" + ], + "enumDescriptions": [ + "Default State for KAJ Enrollment.", + "Pending State for KAJ Enrollment.", + "Complete State for KAJ Enrollment." + ], + "readOnly": true, + "type": "string" + }, "kmsSettings": { "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings", "description": "Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes." @@ -1019,6 +1174,11 @@ }, "readOnly": true, "type": "array" + }, + "saaEnrollmentResponse": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse", + "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.", + "readOnly": true } }, "type": "object" @@ -1147,6 +1307,48 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse": { + "description": "Signed Access Approvals (SAA) enrollment response.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse", + "properties": { + "setupErrors": { + "description": "Indicates SAA enrollment setup error if any.", + "items": { + "enum": [ + "SETUP_ERROR_UNSPECIFIED", + "ERROR_INVALID_BASE_SETUP", + "ERROR_MISSING_EXTERNAL_SIGNING_KEY", + "ERROR_NOT_ALL_SERVICES_ENROLLED", + "ERROR_SETUP_CHECK_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Invalid states for all customers, to be redirected to AA UI for additional details.", + "Returned when there is not an EKM key configured.", + "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", + "Returned when exception was encountered during evaluation of other criteria." + ], + "type": "string" + }, + "type": "array" + }, + "setupStatus": { + "description": "Indicates SAA enrollment status of a given workload.", + "enum": [ + "SETUP_STATE_UNSPECIFIED", + "STATUS_PENDING", + "STATUS_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "SAA enrollment pending.", + "SAA enrollment comopleted." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse", diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index bee5abae1fb..f975713b8d0 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -1307,7 +1307,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/baremetalsolution.v1.json b/googleapiclient/discovery_cache/documents/baremetalsolution.v1.json index c3925f20c07..16decc8d701 100644 --- a/googleapiclient/discovery_cache/documents/baremetalsolution.v1.json +++ b/googleapiclient/discovery_cache/documents/baremetalsolution.v1.json @@ -145,7 +145,7 @@ } } }, - "revision": "20211028", + "revision": "20211207", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "ResetInstanceRequest": { diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index cf1a4d6c7dd..e3aea80e290 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1693,7 +1693,7 @@ } } }, - "revision": "20211129", + "revision": "20211214", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json index b55756b3458..395d68c0f8b 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json @@ -395,7 +395,7 @@ } } }, - "revision": "20211130", + "revision": "20211206", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index eb885c7725c..7f3811fd221 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -788,7 +788,7 @@ } } }, - "revision": "20211125", + "revision": "20211207", "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 8b18a850131..a4cba7b97e2 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20211125", + "revision": "20211207", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v1.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v1.json index df425ada302..e319f0805a7 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": "20211104", + "revision": "20211202", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AutoscalingLimits": { @@ -250,7 +250,7 @@ "type": "string" }, "serveNodes": { - "description": "Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.", + "description": "The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.", "format": "int32", "type": "integer" }, @@ -297,7 +297,7 @@ "properties": { "clusterAutoscalingConfig": { "$ref": "ClusterAutoscalingConfig", - "description": "Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled." + "description": "Autoscaling configuration for this cluster." } }, "type": "object" @@ -596,7 +596,8 @@ "type": "string" }, "originalRequest": { - "$ref": "PartialUpdateClusterRequest" + "$ref": "PartialUpdateClusterRequest", + "description": "The original request for PartialUpdateCluster." }, "requestTime": { "description": "The time at which the original request was received.", @@ -615,7 +616,7 @@ "description": "Required. The Cluster which contains the partial updates to be applied, subject to the update_mask." }, "updateMask": { - "description": "Required. The subset of Cluster fields which should be replaced. Must be explicitly set.", + "description": "Required. The subset of Cluster fields which should be replaced.", "format": "google-fieldmask", "type": "string" } @@ -733,6 +734,27 @@ }, "type": "object" }, + "UndeleteTableMetadata": { + "description": "Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable.", + "id": "UndeleteTableMetadata", + "properties": { + "endTime": { + "description": "If set, the time at which this operation finished or was cancelled.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name of the table being restored.", + "type": "string" + }, + "startTime": { + "description": "The time at which this operation started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "UpdateAppProfileMetadata": { "description": "The metadata for the Operation returned by UpdateAppProfile.", "id": "UpdateAppProfileMetadata", diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 595e73773d4..d79731a7fb5 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -286,7 +286,7 @@ "instances": { "methods": { "create": { - "description": "Create an instance within a project.", + "description": "Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.", "flatPath": "v2/projects/{projectsId}/instances", "httpMethod": "POST", "id": "bigtableadmin.projects.instances.create", @@ -789,7 +789,7 @@ "clusters": { "methods": { "create": { - "description": "Creates a cluster within an instance.", + "description": "Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters", "httpMethod": "POST", "id": "bigtableadmin.projects.instances.clusters.create", @@ -924,7 +924,7 @@ ] }, "partialUpdateCluster": { - "description": "Partially updates a cluster within a project. This method is the preferred way to update a Cluster. ", + "description": "Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}", "httpMethod": "PATCH", "id": "bigtableadmin.projects.instances.clusters.partialUpdateCluster", @@ -940,7 +940,7 @@ "type": "string" }, "updateMask": { - "description": "Required. The subset of Cluster fields which should be replaced. Must be explicitly set.", + "description": "Required. The subset of Cluster fields which should be replaced.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -963,7 +963,7 @@ ] }, "update": { - "description": "Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.", + "description": "Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}", "httpMethod": "PUT", "id": "bigtableadmin.projects.instances.clusters.update", @@ -1803,7 +1803,7 @@ } } }, - "revision": "20211104", + "revision": "20211202", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2076,7 +2076,7 @@ "type": "string" }, "serveNodes": { - "description": "Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.", + "description": "The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.", "format": "int32", "type": "integer" }, @@ -2123,7 +2123,7 @@ "properties": { "clusterAutoscalingConfig": { "$ref": "ClusterAutoscalingConfig", - "description": "Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled." + "description": "Autoscaling configuration for this cluster." } }, "type": "object" @@ -2490,7 +2490,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -2882,7 +2882,8 @@ "type": "string" }, "originalRequest": { - "$ref": "PartialUpdateClusterRequest" + "$ref": "PartialUpdateClusterRequest", + "description": "The original request for PartialUpdateCluster." }, "requestTime": { "description": "The time at which the original request was received.", @@ -2901,7 +2902,7 @@ "description": "Required. The Cluster which contains the partial updates to be applied, subject to the update_mask." }, "updateMask": { - "description": "Required. The subset of Cluster fields which should be replaced. Must be explicitly set.", + "description": "Required. The subset of Cluster fields which should be replaced.", "format": "google-fieldmask", "type": "string" } @@ -3202,6 +3203,27 @@ }, "type": "object" }, + "UndeleteTableMetadata": { + "description": "Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable.", + "id": "UndeleteTableMetadata", + "properties": { + "endTime": { + "description": "If set, the time at which this operation finished or was cancelled.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name of the table being restored.", + "type": "string" + }, + "startTime": { + "description": "The time at which this operation started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Union": { "description": "A GcRule which deletes cells matching any of the given rules.", "id": "Union", diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json index 7d966c6b13b..9bce2f7a3d9 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json @@ -270,7 +270,7 @@ } } }, - "revision": "20211119", + "revision": "20211218", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1Budget": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json index 3da9b8e6cb2..a57e6e11089 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json @@ -264,7 +264,7 @@ } } }, - "revision": "20211119", + "revision": "20211218", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json index 0c117a52154..75d1885551d 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "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 46be2e08865..fcbb93ed35f 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "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 3f84593597a..eb0a67be5b9 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 ca043295c0c..66a1955758b 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1678,7 +1678,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 a43b61caa82..76f307d47ff 100644 --- a/googleapiclient/discovery_cache/documents/books.v1.json +++ b/googleapiclient/discovery_cache/documents/books.v1.json @@ -2671,7 +2671,7 @@ } } }, - "revision": "20211201", + "revision": "20211206", "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 26850fbd9bd..7271e2114d5 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1723,7 +1723,7 @@ } } }, - "revision": "20211105", + "revision": "20211210", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 4a52d9fb2fd..52a49e438d9 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -642,7 +642,7 @@ } } }, - "revision": "20211125", + "revision": "20211225", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -674,12 +674,14 @@ "TYPE_UNSPECIFIED", "NEW_MESSAGE", "UPDATE_MESSAGE", + "UPDATE_USER_MESSAGE_CARDS", "REQUEST_CONFIG" ], "enumDescriptions": [ "Default type; will be handled as NEW_MESSAGE.", "Post as a new message in the topic.", "Update the bot's message. This is only permitted on a CARD_CLICKED event where the message sender type is BOT.", + "Update the cards on a user's message. This is only permitted as a response to a MESSAGE event with a matched url, or a CARD_CLICKED event where the message sender type is HUMAN. Text will be ignored.", "Update a message, with cards only. (Only after a MESSAGE event with a matched url, or a CARD_CLICKED event on a human created message)." ], "type": "string" @@ -2330,6 +2332,17 @@ }, "type": "object" }, + "MatchedUrl": { + "description": "A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling).", + "id": "MatchedUrl", + "properties": { + "url": { + "description": "The url that was matched.", + "type": "string" + } + }, + "type": "object" + }, "Media": { "description": "Media resource.", "id": "Media", @@ -2353,7 +2366,7 @@ }, "member": { "$ref": "User", - "description": "A user in Google Chat." + "description": "A user in Google Chat. Represents a person in the People API. Formatted as `users/person_id` where `person_id` is available from the [People API](https://developers.google.com/people/api/rest/v1/people)." }, "name": { "type": "string" @@ -2426,6 +2439,10 @@ "readOnly": true, "type": "string" }, + "matchedUrl": { + "$ref": "MatchedUrl", + "description": "A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling)." + }, "name": { "description": "Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`", "type": "string" @@ -2704,7 +2721,7 @@ "type": "string" }, "domainId": { - "description": "Obfuscated domain information.", + "description": "Unique identifier of the user's Google Workspace domain.", "type": "string" }, "isAnonymous": { @@ -2712,7 +2729,7 @@ "type": "boolean" }, "name": { - "description": "Resource name, in the format \"users/*\".", + "description": "Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API.", "type": "string" }, "type": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 3cb22a0b527..9e23f10911d 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -488,7 +488,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index cd4350ac847..e35539f381d 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -324,7 +324,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle": { diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index e76978f049b..d8523c6ac2e 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20211202", + "revision": "20211229", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { diff --git a/googleapiclient/discovery_cache/documents/civicinfo.v2.json b/googleapiclient/discovery_cache/documents/civicinfo.v2.json index 17381a200ca..0c40a3deac0 100644 --- a/googleapiclient/discovery_cache/documents/civicinfo.v2.json +++ b/googleapiclient/discovery_cache/documents/civicinfo.v2.json @@ -352,7 +352,7 @@ } } }, - "revision": "20210809", + "revision": "20211211", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { @@ -851,6 +851,793 @@ }, "type": "object" }, + "FeatureIdProto": { + "description": "A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit \"cell id\" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos.", + "id": "FeatureIdProto", + "properties": { + "cellId": { + "description": "The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way.", + "format": "uint64", + "type": "string" + }, + "fprint": { + "description": "A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient.", + "format": "uint64", + "type": "string" + }, + "temporaryData": { + "$ref": "MessageSet", + "description": "A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts." + } + }, + "type": "object" + }, + "GeocodingSummary": { + "description": "Detailed summary of the result from geocoding an address", + "id": "GeocodingSummary", + "properties": { + "addressUnderstood": { + "description": "Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto.", + "type": "boolean" + }, + "featureId": { + "$ref": "FeatureIdProto", + "description": "The ID of the FeatureProto returned by the geocoder" + }, + "featureType": { + "description": "The feature type for the FeatureProto returned by the geocoder", + "enum": [ + "typeAny", + "typeTransportation", + "typeRoute", + "typeDeprecatedHighwayDoNotUse", + "typeHighway", + "typeHighway1", + "typeHighway2", + "typeHighway3", + "typeHighway4", + "typeHighway5", + "typeHighway6", + "typeHighway7", + "typeHighway8", + "typeHighway9", + "typeBicycleRoute", + "typeTrail", + "typeSegment", + "typeRoad", + "typeRailway", + "typeStandardTrack", + "typeJrTrack", + "typeNarrowTrack", + "typeMonorailTrack", + "typeSubwayTrack", + "typeLightRailTrack", + "typeBroadTrack", + "typeHighSpeedRail", + "typeTrolleyTrack", + "typeFerry", + "typeFerryBoat", + "typeFerryTrain", + "typeVirtualSegment", + "typeIntersection", + "typeTransit", + "typeTransitStation", + "typeBusStation", + "typeTramwayStation", + "typeTrainStation", + "typeSubwayStation", + "typeFerryTerminal", + "typeAirport", + "typeAirportCivil", + "typeAirportMilitary", + "typeAirportMixed", + "typeHeliport", + "typeSeaplaneBase", + "typeAirstrip", + "typeCableCarStation", + "typeGondolaLiftStation", + "typeFunicularStation", + "typeSpecialStation", + "typeHorseCarriageStation", + "typeMonorailStation", + "typeSeaport", + "typeTransitStop", + "typeTransitTrip", + "typeTransitDeparture", + "typeTransitLeg", + "typeTransitLine", + "typeTransitAgency", + "typeTransitTransfer", + "typeSegmentPath", + "typeRoadSign", + "typeIntersectionGroup", + "typePathway", + "typeRestrictionGroup", + "typeTollCluster", + "typePolitical", + "typeCountry", + "typeAdministrativeArea", + "typeAdministrativeArea1", + "typeUsState", + "typeGbCountry", + "typeJpTodoufuken", + "typeAdministrativeArea2", + "typeGbFormerPostalCounty", + "typeGbTraditionalCounty", + "typeAdministrativeArea3", + "typeAdministrativeArea4", + "typeAdministrativeArea5", + "typeAdministrativeArea6", + "typeAdministrativeArea7", + "typeAdministrativeArea8", + "typeAdministrativeArea9", + "typeColloquialArea", + "typeReservation", + "typeLocality", + "typeGbPostTown", + "typeJpGun", + "typeJpShikuchouson", + "typeJpSubShikuchouson", + "typeColloquialCity", + "typeSublocality", + "typeUsBorough", + "typeGbDependentLocality", + "typeJpOoaza", + "typeJpKoaza", + "typeJpGaiku", + "typeGbDoubleDependentLocality", + "typeJpChiban", + "typeJpEdaban", + "typeSublocality1", + "typeSublocality2", + "typeSublocality3", + "typeSublocality4", + "typeSublocality5", + "typeNeighborhood", + "typeConstituency", + "typeDesignatedMarketArea", + "typeSchoolDistrict", + "typeLandParcel", + "typeDisputedArea", + "typePoliceJurisdiction", + "typeStatisticalArea", + "typeConstituencyFuture", + "typePark", + "typeGolfCourse", + "typeLocalPark", + "typeNationalPark", + "typeUsNationalPark", + "typeUsNationalMonument", + "typeNationalForest", + "typeProvincialPark", + "typeProvincialForest", + "typeCampgrounds", + "typeHikingArea", + "typeBusiness", + "typeGovernment", + "typeBorderCrossing", + "typeCityHall", + "typeCourthouse", + "typeEmbassy", + "typeLibrary", + "typeSchool", + "typeUniversity", + "typeEmergency", + "typeHospital", + "typePharmacy", + "typePolice", + "typeFire", + "typeDoctor", + "typeDentist", + "typeVeterinarian", + "typeTravelService", + "typeLodging", + "typeRestaurant", + "typeGasStation", + "typeParking", + "typePostOffice", + "typeRestArea", + "typeCashMachine", + "typeCarRental", + "typeCarRepair", + "typeShopping", + "typeGrocery", + "typeTouristDestination", + "typeEcoTouristDestination", + "typeBirdWatching", + "typeFishing", + "typeHunting", + "typeNatureReserve", + "typeTemple", + "typeChurch", + "typeGurudwara", + "typeHinduTemple", + "typeMosque", + "typeSynagogue", + "typeStadium", + "typeBar", + "typeMovieRental", + "typeCoffee", + "typeGolf", + "typeBank", + "typeDoodle", + "typeGrounds", + "typeAirportGrounds", + "typeBuildingGrounds", + "typeCemetery", + "typeHospitalGrounds", + "typeIndustrial", + "typeMilitary", + "typeShoppingCenter", + "typeSportsComplex", + "typeUniversityGrounds", + "typeDeprecatedTarmac", + "typeEnclosedTrafficArea", + "typeParkingLot", + "typeParkingGarage", + "typeOffRoadArea", + "typeBorder", + "typeBuilding", + "typeGeocodedAddress", + "typeNaturalFeature", + "typeTerrain", + "typeSand", + "typeBeach", + "typeDune", + "typeRocky", + "typeIce", + "typeGlacier", + "typeBuiltUpArea", + "typeVegetation", + "typeShrubbery", + "typeWoods", + "typeAgricultural", + "typeGrassland", + "typeTundra", + "typeDesert", + "typeSaltFlat", + "typeWater", + "typeOcean", + "typeBay", + "typeBight", + "typeLagoon", + "typeSea", + "typeStrait", + "typeInlet", + "typeFjord", + "typeLake", + "typeSeasonalLake", + "typeReservoir", + "typePond", + "typeRiver", + "typeRapids", + "typeDistributary", + "typeConfluence", + "typeWaterfall", + "typeSpring", + "typeGeyser", + "typeHotSpring", + "typeSeasonalRiver", + "typeWadi", + "typeEstuary", + "typeWetland", + "typeWaterNavigation", + "typeFord", + "typeCanal", + "typeHarbor", + "typeChannel", + "typeReef", + "typeReefFlat", + "typeReefGrowth", + "typeReefExtent", + "typeReefRockSubmerged", + "typeIrrigation", + "typeDam", + "typeDrinkingWater", + "typeCurrent", + "typeWateringHole", + "typeTectonic", + "typeWateringHoleDeprecated", + "typeVolcano", + "typeLavaField", + "typeFissure", + "typeFault", + "typeLandMass", + "typeContinent", + "typeIsland", + "typeAtoll", + "typeOceanRockExposed", + "typeCay", + "typePeninsula", + "typeIsthmus", + "typeElevated", + "typePeak", + "typeNunatak", + "typeSpur", + "typePass", + "typePlateau", + "typeRidge", + "typeRavine", + "typeCrater", + "typeKarst", + "typeCliff", + "typeVista", + "typeDigitalElevationModel", + "typeUpland", + "typeTerrace", + "typeSlope", + "typeContourLine", + "typePan", + "typeUnstableHillside", + "typeMountainRange", + "typeUndersea", + "typeSubmarineSeamount", + "typeSubmarineRidge", + "typeSubmarineGap", + "typeSubmarinePlateau", + "typeSubmarineDeep", + "typeSubmarineValley", + "typeSubmarineBasin", + "typeSubmarineSlope", + "typeSubmarineCliff", + "typeSubmarinePlain", + "typeSubmarineFractureZone", + "typeCave", + "typeRock", + "typeArchipelago", + "typePostal", + "typePostalCode", + "typePostalCodePrefix", + "typePremise", + "typeSubPremise", + "typeSuite", + "typePostTown", + "typePostalRound", + "typeMetaFeature", + "typeDataSource", + "typeLocale", + "typeTimezone", + "typeBusinessChain", + "typePhoneNumberPrefix", + "typePhoneNumberAreaCode", + "typeBusinessCorridor", + "typeAddressTemplate", + "typeEvent", + "typeEarthquake", + "typeHurricane", + "typeWeatherCondition", + "typeTransient", + "typeEntrance", + "typeCartographic", + "typeHighTension", + "typeSkiTrail", + "typeSkiLift", + "typeSkiBoundary", + "typeWatershedBoundary", + "typeTarmac", + "typeWall", + "typePicnicArea", + "typePlayGround", + "typeTrailHead", + "typeGolfTeeingGround", + "typeGolfPuttingGreen", + "typeGolfRough", + "typeGolfSandBunker", + "typeGolfFairway", + "typeGolfHole", + "typeDeprecatedGolfShop", + "typeCampingSite", + "typeDesignatedBarbecuePit", + "typeDesignatedCookingArea", + "typeCampfirePit", + "typeWaterFountain", + "typeLitterReceptacle", + "typeLockerArea", + "typeAnimalEnclosure", + "typeCartographicLine", + "typeEstablishment", + "typeEstablishmentGrounds", + "typeEstablishmentBuilding", + "typeEstablishmentPoi", + "typeEstablishmentService", + "typeCelestial", + "typeRoadMonitor", + "typePublicSpacesAndMonuments", + "typeStatue", + "typeTownSquare", + "typeLevel", + "typeCompound", + "typeCompoundGrounds", + "typeCompoundBuilding", + "typeCompoundSection", + "typeTerminalPoint", + "typeRegulatedArea", + "typeDoNotUseReservedToCatchGeneratedFiles", + "typeUnknown" + ], + "enumDescriptions": [ + "ABSTRACT", + "ABSTRACT", + "A route is any section of road (or rails, etc.) that has a name. This includes city streets as well as highways. Road segments can belong to multiple routes (e.g. El Camino, CA-82).", + "DEPRECATED", + "ABSTRACT", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "A designated bicycle route, whose segments may consist of any combination of bicycle paths, bicycle lanes, or city streets.", + "A designated trail, which may consist of paved walkways, dirt paths, fire road, streets or highways, etc.", + "ABSTRACT", + "", + "Railroads use several different incompatible track types.", + "", + "", + "", + "", + "", + "", + "", + "", + "Tracks for streetcars, cable-cars, etc. Ferries are services that are part of the road network but are not roads. They typically involve fares and scheduled departure times.", + "ABSTRACT", + "The vast majority of ferries are ferry boats.", + "Also called a \"car transport\", a ferry train is a rail service that carries passengers and their vehicles across undrivable terrain. The Channel Tunnel (\"Chunnel\") is the most famous example, but they are also common in the Alps where they connect neighboring valleys otherwise separated by impassable mountains.", + "Any plausible 1-dimensional path through a 2+ dimensional space, for the purposes of making graph-search-based routing possible. Such segments can be used to model paths through parking lots, squares, floors of buildings and other areas.", + "An intersection consists of a collection of segments that terminate at the same location. This is topological definition: it may not match what a typical user would think of as an \"intersection\". See TYPE_INTERSECTION_GROUP, below, for more information. Each segment terminating at an intersection has an \"endpoint type\" that specifies how that segment is terminated: stop sign, yield sign, three-way light, etc.", + "ABSTRACT", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "A transit line is a collection of transit legs, associated with some invariant properties of the trips that run over the legs. See also transitline.proto", + "A transit agency operates a number of lines, typically all in the same city, region or country. See also transitagency.proto", + "DEPRECATED", + "ABSTRACT", + "Road sign features have names, point geometry, etc. They also have segment_path data (see below) which lists the segments that refer to the sign. See segment.proto for the reference from the segment to the road sign.", + "Our TYPE_INTERSECTION feature, above, models the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an \"intersection\". Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. This TYPE_INTERSECTION_GROUP is used to model the user's concept of a complex intersection.", + "RESERVED", + "A restriction group describes a set of segment restrictions that belong together and have a name or an associated event. See also restriction_group.proto", + "A toll cluster is either a single point on a segment (represented as a point at the end of the segment that has ENDPOINT_TOLL_BOOTH set) or a group of points on various road segments in MapFacts that represents one or more lanes passing through a toll fixture that all go to the same routing destination. Each toll cluster should have at most a single price per payment method. E.g. {CASH = $5, PASS = $1}. Note: If a toll fixture has different prices for multiple routing destinations, drivers need to be in the correct lane before passing through the toll fixture and hence such a fixture is represented by multiple toll clusters. A toll cluster does not necessarily represent a real-world entity, e.g. a particular plaza/structure as perceived by humans. This is because a plaza can be represented by more than one toll cluster. We require toll clusters to have names, but they might be non-unique. For example, a plaza might be represented by multiple toll clusters that may have the same plaza name. For further details, please see go/toll-cluster-schema.", + "ABSTRACT", + "", + "ABSTRACT", + "", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "e.g. Silicon Valley", + "A reservation is a region collectively held or governed by indigenous people and officially recognized by the country\u2019s government at the federal or state level. A reservation may be fully contained within an administrative feature or partially contained within two or more. These regions are referred to by different categorical names depending on country and even by state, including but not limited to: \u201cIndian Reservations\u201d, \u201cIndian Reserves\u201d, \u201cLand Claim Settlement Lands\u201d, \u201cIndian Lands\u201d, \u201cTreaty Lands\u201d, \u201cIndigenous Territories\u201d, etc. A reservation is not a historic indigenous territory boundary or a region which has applied for land rights but has not yet received official recognition.", + "", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "An entity widely considered to be a city, that may itself be made up of smaller political entities, some of which are cities/towns/villages themselves. For example, the colloquial view of Sydney, Australia actually comprises many smaller cities, but is regarded as a city itself. This type is not suitable for modeling official metro-/micropolitan or other statistical areas.", + "ABSTRACT", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "Designated Market Areas (or DMAs) are used by marketing and ratings companies (such as the Nielsen Media Research company) to describe geographical regions (such as the greater New York metropolitan area) that are covered by a set of television stations. (See http://www.schooldata.com/pdfs/DMA.pdf) In the United States, DMAs should have a DMA numeric ID name, tagged with the FLAG_DESIGNATED_MARKET_AREA_ID flag.", + "", + "", + "Eventually we'll have more data for disputed areas (e.g., who makes claims on the area, who has de facto control, etc.). For the moment, we just define a type so we can simply mark areas as disputed.", + "Boundaries representing the jurisdiction of a particular police station.", + "An area used for aggregating statistical data, eg, a census region. Note that TYPE_STATISTICAL_AREA has a third nibble so we can add an abstract parent above it later if need be at 0x2E1 (and rename TYPE_STATISTICAL_AREA as TYPE_STATISTICAL_AREA1).", + "RESERVED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "A line representing the boundary between two features. See border.proto for details.", + "DEPRECATED", + "An association of a point with an address, with no other information.", + "ABSTRACT", + "Expanses of land that share common surface attributes. These areas would look more or less uniform from a high altitude.", + "", + "", + "", + "", + "", + "", + "Terrain that looks populated.", + "Terrain that is covered in vegetation.", + "", + "", + "", + "", + "", + "", + "A flat expanse of salt left by the evaporation of a body of salt water.", + "Features can be TYPE_WATER if we don't have enough information to properly type the body of water. TYPE_WATER is also used as the type for child features that compose a TYPE_RIVER feature.", + "One of the large salt-water bodies that covers most of the globe.", + "An ocean subdivision formed by a coastal indentation. Includes coves and gulfs.", + "An open body of water formed by a slight coastal indentation.", + "", + "An ocean subdivision more or less confined by land and islands.", + "A long narrow ocean subdivision. Includes sounds.", + "", + "", + "An inland body of standing water.", + "A lake that dries up part of the year.", + "An artificial body of water, possibly created by a dam, often used for irrigation or house use.", + "", + "An inland body of moving water, or parts associated with it in which there is little or no current (backwater).", + "", + "A branch which flows away from the main river. Includes deltas.", + "A place where two or more rivers join.", + "", + "A place where ground water flows naturally out of the ground.", + "", + "", + "A river that dries up part of the year.", + "A dry riverbed that occasionally receives flashfloods.", + "A place at the end of a river where fresh and salt water mix. Includes tidal creeks and limans.", + "Land that is usually flooded. Includes bogs, marshes, flats, moors, and swamps.", + "", + "A shallow place where water may be waded through.", + "A narrow passage used by boats. Normally artificial.", + "A deep place near a shore where ships commonly drop anchor.", + "A deep part in a body of water that is suitable for navigation. Includes narrows.", + "Rocks, coral, sandbars, or other features beneath the surface of the water that pose a hazard to passing ships. Includes shoals.", + "A relatively shallow zone of the back reef located closest to the shore, that may be exposed at low tide.", + "A small section of rocks, coral, sandbars, or other features beneath the surface of the water that forms part of a reef.", + "The full extent of the reef complex.", + "A submerged rock in the water.", + "Man-made (and sometimes natural) channels used to move water. This type was used for both dam structures and water that is hold back by dams. We should use TYPE_COMPOUND_BUILDING for dam structures and TYPE_RESERVOIR for water.", + "DEPRECATED", + "", + "Includes overfalls.", + "A natural depression filled with water where animals come to drink.", + "ABSTRACT This type is incorrectly under TYPE_TECTONIC instead of TYPE_WATER. This was a mistake and is now fixed. See TYPE_WATERING_HOLE for the replacement.", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "", + "", + "An exposed rock in the water.", + "A small, low-elevation, sandy island formed on the surface of coral reefs", + "A stretch of land projecting into water. Includes capes and spits.", + "A strip of land connecting two larger land masses, such as continents.", + "Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", + "Elevations that have a distinctive peak.", + "A peak or ridge of a mountain that extends through a glacier.", + "A subsidiary peak of a mountain.", + "A route over an otherwise difficult to traverse feature. Includes saddle.", + "Elevations that are flat on top. Includes mesas and buttes.", + "A ridge is a geographical feature consisting of a chain of mountains or hills that form a continuous elevated crest with a single ridgeline for some distance.", + "Steep declines usually carved by erosion. Includes valleys, canyons, ditches, and gorges.", + "Depressions causes by impact, explosion, and sometimes sink-holes.", + "Topography formed on limestone and gypsum by dissolution with sinkholes, caves, etc.", + "A vertical or nearly vertical slope. Includes escarpments.", + "An elevated place that is notable for having a good view. Raster digital elevation data. This is not a type to be used by providers or consumed by clients.", + "RESERVED", + "Land along streams higher than the alluvial plain or stream terrace.", + "", + "Land not so steep as a cliff, but changing elevation. Includes slides.", + "All the points on the polygon are at the same elevation.", + "A near-level shallow, natural depression or basin, usually containing an intermittent lake, pond, or pool.", + "", + "A series of mountains or hills ranged in a line and connected by high ground. Mountain ranges usually consist of many smaller ridges. For example, the Himalayas, the Andes. the Alps, etc.", + "Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", + "includes peaks, ranges, and spurs", + "", + "includes saddles", + "", + "", + "includes trenches and troughs", + "", + "", + "", + "", + "", + "Don't use 0xA7. Use 8 bits for additional types under TYPE_NATURAL_FEATURE, so we don't run out of space. The following are miscellaneous natural features that don't fit any of the categories above.", + "", + "A feature representing a group or chain of islands. ", + "ABSTRACT", + "This is the type for postal codes which are complete and independent enough that there should be a feature for them (e.g. US 5-digit ZIP codes). For even more detailed suffixes that further subdivide a postal code (such as the +4 component in US ZIP codes), store the information in a TYPE_POSTAL_CODE_SUFFIX address component. When a range or set of postal codes share the same geographical area, e.g. because a precise subdivision does not exist or this subdivision is unknown, this type is used for each individual postal code.", + "A prefix portion of a postal code which does not meet the requirements for TYPE_POSTAL_CODE, but which is useful to search for, for example UK outcodes.", + "DEPRECATED", + "DEPRECATED This is deprecated and we want to use TYPE_COMPOUND_SECTION instead.", + "DEPRECATED", + "The term \"post town\" is used for a locality-like-entity that is only used for postal addresses.", + "DEPRECATED", + "ABSTRACT", + "Every data source used in constructing a data repository has a corresponding feature that provides more information about that data source. The extra information is stored in the optional data_source field below.", + "A locale feature provides region specific conventions such as preferred language and formatting details for time, date, and currency values. Locales aren't necessary defined by physical geographic features, so they are classified as meta-features.", + "A timezone feature is used to specify the region covering an international timezone. When a point is covered by multiple timezone features, the most specific one can be used to compute the local time at this point. Most specific implies a much smaller region or the one that is closer to the center. A feature's timezone can be specified in the repeated related_timezone field.", + "A business chain feature is used to represent a chain, e.g. Starbucks, McDonald's, etc. Other features representing specific stores/franchises of this chain may refer to one such feature via RELATION_MEMBER_OF_CHAIN. This is not strictly reserved to commercial chains but can also be used to model organizations such as the Red Cross or the United Nations.", + "A phone number prefix feature is used to specify the region where phone numbers (typically fixed-line numbers) must begin with a certain prefix. Any phone number prefix down to any level of granularity could be represented by this type.", + "A phone number area code is a prefix which also coincides with the area code, or national destination code, of a particular region.", + "A Business Corridor is a dense cluster of semantically similar establishments. TYPE_BUSINESS_CORRIDOR features are distinguished from TYPE_COLLOQUIAL_AREA features because the corridors are not under the political hierarchy, are allowed to be nameless, and may not correspond to well-known real world locations. For more details, see go/geo-corridors-schema.", + "An address template feature provides region-specific conventions for structuring addresses. These features aren't necessarily defined by physical geographic features, so they are classified as meta-features.", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "DEPRECATED", + "RESERVED", + "A portal of entry or exit to another feature. Examples: - Subway station entrance. - Parking lot entrance.", + "Cartographic features are used to capture real-world objects for which there is no current desire to model any specific attributes. These are only useful to make the map tiles look pretty.", + "DEPRECATED", + "Also see skitrail.proto", + "Also see skilift.proto", + "Also see skiboundary.proto", + "", + "Starting with TYPE_TARMAC, we use longer IDs, so that we can expand the number of feature types under TYPE_CARTOGRAPHIC.", + "Use TYPE_COMPOUND_GROUND and appropriate gcids for the next two.", + "DEPRECATED", + "DEPRECATED", + "", + "Sub-types within a golf course.", + "", + "", + "", + "", + "Use TYPE_ESTABLISHMENT_POI and gcid:golf_shop for golf shops instead.", + "DEPRECATED", + "DEPRECATED", + "", + "", + "", + "", + "", + "", + "Subtype within a zoo - a cage or fenced-off or otherwise delineated area containing animals.", + "A line for a cartographic detail. For example the international date line. Such features should have polyline geometry.", + "ABSTRACT This type is being replaced by TYPE_COMPOUND_GROUNDS. For further details, see go/compounds-v2", + "DEPRECATED This type has been replaced by TYPE_COMPOUND_BUILDING. For further details, see go/oyster-compounds", + "DEPRECATED", + "Establishment POIs can be referenced by TYPE_COMPOUND features using the RELATION_PRIMARILY_OCCUPIED_BY. This is the reciprocal relation of the RELATION_OCCUPIES.", + "Represents service-only establishments (those without a storefront location). NOTE(tcain): Using value 0xD441, since we could find ourselves with a need to differentiate service areas from online-only at this level in the future, but still benefit from being able to group those under a common parent, disjoint from TYPE_ESTABLISHMENT_POI.", + "The root of types of features that are in the sky, rather than on the earth. There will eventually be a hierarchy of types here.", + "Features responsible for monitoring traffic on roads (usually for speed). Includes cameras at particular points as well as monitors that cover larger spans. Features of this type should have a corresponding gcid that specifies the correct subtype (e.g. gcid:road_camera or gcid:speed_camera_zone). This type was originally named as TYPE_ROAD_CAMERA.", + "ABSTRACT", + "Note that this type does not distinguish the nature of the statue (religious, historical, memorial, tourist, ...).", + "Open space used for events, gathering, or as market-place.", + "A feature used to represent a logical level, e.g. floor.", + "ABSTRACT", + "e.g. campus, compound, parcel.", + "e.g. single family dwelling, office building.", + "e.g. suite, room, hallway, cubicle.", + "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone. Features of this type should have one or more gcids corresponding to their specific regulation.", + "DEPRECATED", + "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." + ], + "type": "string" + }, + "positionPrecisionMeters": { + "description": "Precision of the center point (lat/long) of the geocoded FeatureProto", + "format": "double", + "type": "number" + }, + "queryString": { + "description": "The query sent to the geocoder", + "type": "string" + } + }, + "type": "object" + }, "GeographicDivision": { "description": "Describes a political geography.", "id": "GeographicDivision", @@ -877,6 +1664,12 @@ }, "type": "object" }, + "MessageSet": { + "description": "This is proto2's version of MessageSet.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "Office": { "description": "Information about an Office held by one or more Officials.", "id": "Office", @@ -996,6 +1789,13 @@ }, "type": "array" }, + "geocodingSummaries": { + "description": "Detailed summary about the official's address's geocoding", + "items": { + "$ref": "GeocodingSummary" + }, + "type": "array" + }, "name": { "description": "The official's name.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index 862ef1f1b02..c8fbc1c1fef 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -2400,7 +2400,7 @@ } } }, - "revision": "20211130", + "revision": "20211218", "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 b58a9130e7f..89b666eb1a2 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -894,7 +894,7 @@ } } }, - "revision": "20211125", + "revision": "20211210", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 79151faabbc..fd3a7ddb77d 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20211125", + "revision": "20211210", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index b7dfaef3044..1d2b1603561 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20211125", + "revision": "20211210", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json index 057a7a729ee..535171a3c7b 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p4beta1.json @@ -221,7 +221,7 @@ } } }, - "revision": "20211125", + "revision": "20211210", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index 190740c3e34..8add6ec3527 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, - "revision": "20211125", + "revision": "20211210", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index b9012fecdb5..b8eadcd44e0 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20211125", + "revision": "20211210", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json index a7f831bbaa1..05281fa4213 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json @@ -369,7 +369,7 @@ "projects": { "methods": { "getBillingInfo": { - "description": "Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).", + "description": "Gets the billing information for a project. The current authenticated user must have the `resourcemanager.projects.get` permission for the project, which can be granted by assigning the [Project Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) role.", "flatPath": "v1/projects/{projectsId}/billingInfo", "httpMethod": "GET", "id": "cloudbilling.projects.getBillingInfo", @@ -521,7 +521,7 @@ } } }, - "revision": "20211112", + "revision": "20211211", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index 5c7ad6081d8..bc69e213587 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -1589,7 +1589,7 @@ } } }, - "revision": "20211202", + "revision": "20211211", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { diff --git a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json index ad4ff24f295..bc8f3b8bbce 100644 --- a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json +++ b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json @@ -448,7 +448,7 @@ } } }, - "revision": "20211130", + "revision": "20211207", "rootUrl": "https://clouddebugger.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 38ae11593c4..074a4037ba8 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -1201,7 +1201,7 @@ } } }, - "revision": "20211201", + "revision": "20211212", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "ApproveRolloutRequest": { @@ -2003,6 +2003,25 @@ "readOnly": true, "type": "string" }, + "deployFailureCause": { + "description": "Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress.", + "enum": [ + "FAILURE_CAUSE_UNSPECIFIED", + "CLOUD_BUILD_UNAVAILABLE", + "EXECUTION_FAILED", + "DEADLINE_EXCEEDED", + "RELEASE_FAILED" + ], + "enumDescriptions": [ + "No reason for failure is specified.", + "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](/deploy/docs/cloud-deploy-service-account#required_permissions).", + "The deploy operation did not complete successfully; check Cloud Build logs.", + "Deployment did not complete within the alloted time.", + "Release is in a failed state." + ], + "readOnly": true, + "type": "string" + }, "deployStartTime": { "description": "Output only. Time at which the `Rollout` started deploying.", "format": "google-datetime", @@ -2267,6 +2286,21 @@ "description": "Details of rendering for a single target.", "id": "TargetRender", "properties": { + "failureCause": { + "description": "Output only. Reason this render failed. This will always be unspecified while the render in progress.", + "enum": [ + "FAILURE_CAUSE_UNSPECIFIED", + "CLOUD_BUILD_UNAVAILABLE", + "EXECUTION_FAILED" + ], + "enumDescriptions": [ + "No reason for failure is specified.", + "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](/deploy/docs/cloud-deploy-service-account#required_permissions).", + "The render operation did not complete successfully; check Cloud Build logs." + ], + "readOnly": true, + "type": "string" + }, "renderingBuild": { "description": "Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json index e5a3dffdeac..73a6e5b3f31 100644 --- a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json @@ -430,7 +430,7 @@ } } }, - "revision": "20211111", + "revision": "20211202", "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 d572a4e07fb..639d596c08c 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -546,7 +546,7 @@ } } }, - "revision": "20211130", + "revision": "20211206", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index be7ea14f127..72cb462d40b 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -757,6 +757,39 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getSecuritySettings": { + "description": "Get Security Settings", + "flatPath": "v1/groups/{groupsId}/securitySettings", + "httpMethod": "GET", + "id": "cloudidentity.groups.getSecuritySettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings`", + "location": "path", + "pattern": "^groups/[^/]+/securitySettings$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Field-level read mask of which fields to return. \"*\" returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SecuritySettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.groups", + "https://www.googleapis.com/auth/cloud-identity.groups.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists the `Group` resources under a customer or namespace.", "flatPath": "v1/groups", @@ -917,6 +950,41 @@ "https://www.googleapis.com/auth/cloud-identity.groups.readonly", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateSecuritySettings": { + "description": "Update Security Settings", + "flatPath": "v1/groups/{groupsId}/securitySettings", + "httpMethod": "PATCH", + "id": "cloudidentity.groups.updateSecuritySettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.", + "location": "path", + "pattern": "^groups/[^/]+/securitySettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "SecuritySettings" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.groups", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1273,7 +1341,7 @@ } } }, - "revision": "20211116", + "revision": "20211220", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "CheckTransitiveMembershipResponse": { @@ -2404,6 +2472,21 @@ }, "type": "object" }, + "MemberRestriction": { + "description": "The definition of MemberRestriction", + "id": "MemberRestriction", + "properties": { + "evaluation": { + "$ref": "RestrictionEvaluation", + "description": "The evaluated state of this restriction on a group." + }, + "query": { + "description": "Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&&`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`", + "type": "string" + } + }, + "type": "object" + }, "Membership": { "description": "A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a \"member\".", "id": "Membership", @@ -2489,6 +2572,36 @@ "name": { "description": "The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.", "type": "string" + }, + "restrictionEvaluations": { + "$ref": "RestrictionEvaluations", + "description": "Evaluations of restrictions applied to parent group on this membership." + } + }, + "type": "object" + }, + "MembershipRoleRestrictionEvaluation": { + "description": "The evaluated state of this restriction.", + "id": "MembershipRoleRestrictionEvaluation", + "properties": { + "state": { + "description": "Output only. The current state of the restriction", + "enum": [ + "STATE_UNSPECIFIED", + "COMPLIANT", + "FORWARD_COMPLIANT", + "NON_COMPLIANT", + "EVALUATING" + ], + "enumDescriptions": [ + "Default. Should not be used.", + "The member adheres to the parent group's restriction.", + "The group-group membership might be currently violating some parent group's restriction but in future, it will never allow any new member in the child group which can violate parent group's restriction.", + "The member violates the parent group's restriction.", + "The state of the membership is under evaluation." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -2567,6 +2680,43 @@ }, "type": "object" }, + "RestrictionEvaluation": { + "description": "The evaluated state of this restriction.", + "id": "RestrictionEvaluation", + "properties": { + "state": { + "description": "Output only. The current state of the restriction", + "enum": [ + "STATE_UNSPECIFIED", + "EVALUATING", + "COMPLIANT", + "FORWARD_COMPLIANT", + "NON_COMPLIANT" + ], + "enumDescriptions": [ + "Default. Should not be used.", + "The restriction state is currently being evaluated.", + "All transitive memberships are adhering to restriction.", + "Some transitive memberships violate the restriction. No new violating memberships can be added.", + "Some transitive memberships violate the restriction. New violating direct memberships will be denied while indirect memberships may be added." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RestrictionEvaluations": { + "description": "Evaluations of restrictions applied to parent group on this membership.", + "id": "RestrictionEvaluations", + "properties": { + "memberRestrictionEvaluation": { + "$ref": "MembershipRoleRestrictionEvaluation", + "description": "Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation." + } + }, + "type": "object" + }, "SearchGroupsResponse": { "description": "The response message for GroupsService.SearchGroups.", "id": "SearchGroupsResponse", @@ -2621,6 +2771,22 @@ }, "type": "object" }, + "SecuritySettings": { + "description": "The definition of security settings.", + "id": "SecuritySettings", + "properties": { + "memberRestriction": { + "$ref": "MemberRestriction", + "description": "The Member Restriction value" + }, + "name": { + "description": "Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index f5a89b4f4e5..f8e22cfbb94 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -1404,7 +1404,7 @@ } } }, - "revision": "20211116", + "revision": "20211220", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AndroidAttributes": { @@ -1516,9 +1516,9 @@ }, "type": "object" }, - "CertificateInfo": { + "CertificateAttributes": { "description": "Stores information about a certificate.", - "id": "CertificateInfo", + "id": "CertificateAttributes", "properties": { "certificateTemplate": { "$ref": "CertificateTemplate", @@ -2138,13 +2138,13 @@ "type": "object" }, "EndpointVerificationSpecificAttributes": { - "description": "Resource representing the Endpoint Verification-specific attributes of a Device.", + "description": "Resource representing the Endpoint Verification-specific attributes of a Device. https://cloud.google.com/endpoint-verification/docs/overview", "id": "EndpointVerificationSpecificAttributes", "properties": { - "certificateInfo": { + "certificateAttributes": { "description": "Details of certificates.", "items": { - "$ref": "CertificateInfo" + "$ref": "CertificateAttributes" }, "type": "array" } diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 6acb3b143c1..d070c19399f 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -1440,7 +1440,7 @@ } } }, - "revision": "20211130", + "revision": "20211209", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json index a204084ab55..5ea569cde36 100644 --- a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json @@ -216,7 +216,7 @@ } } }, - "revision": "20211112", + "revision": "20211218", "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 7eaa2709ed2..80725cda939 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -1171,7 +1171,7 @@ } } }, - "revision": "20211111", + "revision": "20211206", "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 33d6922a95a..1130f1c2b90 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20211111", + "revision": "20211206", "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 4b4b79957a7..8a63fbc9788 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20211111", + "revision": "20211206", "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 9b3595e554b..4eb4146a32c 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20211111", + "revision": "20211206", "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 209e2d29532..3f8e7d93da4 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -1612,7 +1612,7 @@ } } }, - "revision": "20211111", + "revision": "20211206", "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 f6290e5f023..421f0da6c79 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json @@ -418,7 +418,7 @@ } } }, - "revision": "20211106", + "revision": "20211202", "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 3fb11fc72b5..8361ac2b4bf 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json @@ -433,7 +433,7 @@ } } }, - "revision": "20211106", + "revision": "20211202", "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 6606765a2f6..666dc3b762a 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -521,7 +521,7 @@ "type": "string" }, "version": { - "description": "Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.", + "description": "Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.", "format": "byte", "location": "query", "type": "string" @@ -1519,6 +1519,60 @@ "https://www.googleapis.com/auth/cloud_search.stats.indexing" ] }, + "getSearchapplication": { + "description": "Get search application stats for customer. **Note:** This API requires a standard end user account to execute.", + "flatPath": "v1/stats/searchapplication", + "httpMethod": "GET", + "id": "cloudsearch.stats.getSearchapplication", + "parameterOrder": [], + "parameters": { + "endDate.day": { + "description": "Day of month. Must be from 1 to 31 and valid for the year and month.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of date. Must be from 1 to 12.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of date. Must be from 1 to 9999.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.day": { + "description": "Day of month. Must be from 1 to 31 and valid for the year and month.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of date. Must be from 1 to 12.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of date. Must be from 1 to 9999.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/stats/searchapplication", + "response": { + "$ref": "GetCustomerSearchApplicationStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud_search", + "https://www.googleapis.com/auth/cloud_search.stats", + "https://www.googleapis.com/auth/cloud_search.stats.indexing" + ] + }, "getSession": { "description": "Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute.", "flatPath": "v1/stats/session", @@ -1940,7 +1994,7 @@ } } }, - "revision": "20211130", + "revision": "20211208", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "AuditLoggingSettings": { @@ -2077,6 +2131,22 @@ }, "type": "object" }, + "CustomerSearchApplicationStats": { + "description": "Search application stats for a customer for the given date.", + "id": "CustomerSearchApplicationStats", + "properties": { + "count": { + "description": "The count of search applications for the date.", + "format": "int64", + "type": "string" + }, + "date": { + "$ref": "Date", + "description": "Date for which search application stats were calculated." + } + }, + "type": "object" + }, "CustomerSessionStats": { "id": "CustomerSessionStats", "properties": { @@ -2173,6 +2243,10 @@ }, "type": "array" }, + "returnThumbnailUrls": { + "description": "Can a user request to get thumbnail URI for Items indexed in this data source.", + "type": "boolean" + }, "shortName": { "description": "A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.", "type": "string" @@ -2726,6 +2800,11 @@ "GetCustomerIndexStatsResponse": { "id": "GetCustomerIndexStatsResponse", "properties": { + "averageIndexedItemCount": { + "description": "Average item count for the given date range for which billing is done.", + "format": "int64", + "type": "string" + }, "stats": { "description": "Summary of indexed item counts, one for each day in the requested range.", "items": { @@ -2744,6 +2823,30 @@ "$ref": "CustomerQueryStats" }, "type": "array" + }, + "totalQueryCount": { + "description": "Total successful query count (status code 200) for the given date range.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GetCustomerSearchApplicationStatsResponse": { + "description": "Response format for search application stats for a customer.", + "id": "GetCustomerSearchApplicationStatsResponse", + "properties": { + "averageSearchApplicationCount": { + "description": "Average search application count for the given date range.", + "format": "int64", + "type": "string" + }, + "stats": { + "description": "Search application stats by date.", + "items": { + "$ref": "CustomerSearchApplicationStats" + }, + "type": "array" } }, "type": "object" @@ -2775,6 +2878,11 @@ "GetDataSourceIndexStatsResponse": { "id": "GetDataSourceIndexStatsResponse", "properties": { + "averageIndexedItemCount": { + "description": "Average item count for the given date range for which billing is done.", + "format": "int64", + "type": "string" + }, "stats": { "description": "Summary of indexed item counts, one for each day in the requested range.", "items": { @@ -2795,6 +2903,11 @@ "$ref": "SearchApplicationQueryStats" }, "type": "array" + }, + "totalQueryCount": { + "description": "Total successful query count (status code 200) for the given date range.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -3065,7 +3178,7 @@ "description": "The structured data for the item that should conform to a registered object definition in the schema for the data source." }, "version": { - "description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.", + "description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.", "format": "byte", "type": "string" } @@ -3163,6 +3276,11 @@ "format": "int64", "type": "string" }, + "indexedItemsCount": { + "description": "Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code.", + "format": "int64", + "type": "string" + }, "statusCode": { "description": "Status of the items.", "enum": [ @@ -3486,6 +3604,10 @@ "$ref": "Source", "description": "The named source for the result, such as Gmail." }, + "thumbnailUrl": { + "description": "The thumbnail URL of the result.", + "type": "string" + }, "updateTime": { "description": "The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.", "format": "google-datetime", @@ -4490,6 +4612,10 @@ "$ref": "QueryInterpretationConfig", "description": "The default options for query interpretation" }, + "returnResultThumbnailUrls": { + "description": "With each result we should return the URI for its thumbnail (when applicable)", + "type": "boolean" + }, "scoringConfig": { "$ref": "ScoringConfig", "description": "Configuration for ranking results." diff --git a/googleapiclient/discovery_cache/documents/cloudshell.v1.json b/googleapiclient/discovery_cache/documents/cloudshell.v1.json index 76655c90ecc..86da1dec399 100644 --- a/googleapiclient/discovery_cache/documents/cloudshell.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudshell.v1.json @@ -374,7 +374,7 @@ } } }, - "revision": "20211115", + "revision": "20211218", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index c0bbe5b5b1c..fc6e5540a41 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -580,7 +580,7 @@ } } }, - "revision": "20211203", + "revision": "20211214", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index c0e5feaa3bb..88a4f35ca02 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -685,7 +685,7 @@ } } }, - "revision": "20211103", + "revision": "20211130", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -880,7 +880,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -900,7 +900,7 @@ "additionalProperties": { "type": "string" }, - "description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * X-Google-*: Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.", + "description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.", "type": "object" }, "httpMethod": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index 4bcf3044a66..cca875a0cb7 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -809,7 +809,7 @@ } } }, - "revision": "20211103", + "revision": "20211130", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -1049,7 +1049,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index f73f1e51471..a7adad9bbe3 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -697,7 +697,7 @@ } } }, - "revision": "20211103", + "revision": "20211130", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -903,7 +903,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -923,7 +923,7 @@ "additionalProperties": { "type": "string" }, - "description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * X-Google-*: Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.", + "description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.", "type": "object" }, "httpMethod": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json index 26c8a7e5409..beeb8478bf7 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json @@ -257,7 +257,7 @@ } } }, - "revision": "20211115", + "revision": "20211203", "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 d065cb8d650..169eedffdd5 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json @@ -181,7 +181,7 @@ } } }, - "revision": "20211115", + "revision": "20211203", "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 63ca44a53ef..fc19a8ed51b 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json @@ -273,7 +273,7 @@ } } }, - "revision": "20211115", + "revision": "20211203", "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 d1b3bafb72c..f537c7f9e3f 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -406,7 +406,7 @@ } } }, - "revision": "20211130", + "revision": "20211208", "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 1f5fb11a6a8..489970ade3e 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -462,7 +462,7 @@ } } }, - "revision": "20211130", + "revision": "20211208", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index ac15701f1c4..c8a262b7dad 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -2458,7 +2458,7 @@ ] }, "createSnapshot": { - "description": "Creates a snapshot of a specified persistent disk.", + "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", "httpMethod": "POST", "id": "compute.disks.createSnapshot", @@ -3002,7 +3002,7 @@ ] }, "update": { - "description": "Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.", + "description": "Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.disks.update", @@ -6289,7 +6289,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -6355,7 +6355,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -6452,7 +6452,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -9072,7 +9072,7 @@ ] }, "stopInstances": { - "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is stopped, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_STOP on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not stopped. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.", + "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "httpMethod": "POST", "id": "compute.instanceGroupManagers.stopInstances", @@ -9120,7 +9120,7 @@ ] }, "suspendInstances": { - "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.", + "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "httpMethod": "POST", "id": "compute.instanceGroupManagers.suspendInstances", @@ -19920,7 +19920,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -19986,7 +19986,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -20083,7 +20083,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -20197,7 +20197,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -20279,7 +20279,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -20392,7 +20392,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -21768,7 +21768,7 @@ ] }, "createSnapshot": { - "description": "Creates a snapshot of this regional disk.", + "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", "httpMethod": "POST", "id": "compute.regionDisks.createSnapshot", @@ -24186,7 +24186,7 @@ ] }, "stopInstances": { - "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is stopped, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_STOP on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not stopped. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.", + "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "httpMethod": "POST", "id": "compute.regionInstanceGroupManagers.stopInstances", @@ -24234,7 +24234,7 @@ ] }, "suspendInstances": { - "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.", + "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "httpMethod": "POST", "id": "compute.regionInstanceGroupManagers.suspendInstances", @@ -26329,7 +26329,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -26411,7 +26411,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -27013,7 +27013,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -27102,7 +27102,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -27957,7 +27957,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -28046,7 +28046,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -28152,7 +28152,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -28202,7 +28202,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -31155,7 +31155,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -31293,7 +31293,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -31398,7 +31398,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -31632,7 +31632,7 @@ ] }, "insert": { - "description": "Creates a snapshot in the specified project using the data included in the request.", + "description": "Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/global/snapshots", "httpMethod": "POST", "id": "compute.snapshots.insert", @@ -31914,7 +31914,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -31987,7 +31987,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -33093,7 +33093,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -33166,7 +33166,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -33256,7 +33256,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -33563,7 +33563,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -33912,7 +33912,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -37620,7 +37620,7 @@ } } }, - "revision": "20211130", + "revision": "20211208", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -38032,11 +38032,11 @@ "id": "AccessConfig", "properties": { "externalIpv6": { - "description": "[Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.", + "description": "The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.", "type": "string" }, "externalIpv6PrefixLength": { - "description": "[Output Only] The prefix length of the external IPv6 range.", + "description": "The prefix length of the external IPv6 range.", "format": "int32", "type": "integer" }, @@ -39003,6 +39003,10 @@ "$ref": "CustomerEncryptionKey", "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys." }, + "sourceInstantSnapshot": { + "description": "The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set.", + "type": "string" + }, "sourceSnapshot": { "description": "The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.", "type": "string" @@ -44627,6 +44631,13 @@ }, "type": "array" }, + "destRegionCodes": { + "description": "Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.\"US\" Maximum number of dest region codes allowed is 5000.", + "items": { + "type": "string" + }, + "type": "array" + }, "layer4Configs": { "description": "Pairs of IP protocols and ports that the rule should match.", "items": { @@ -44655,6 +44666,13 @@ }, "type": "array" }, + "srcRegionCodes": { + "description": "Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.\"US\" Maximum number of source region codes allowed is 5000.", + "items": { + "type": "string" + }, + "type": "array" + }, "srcSecureTags": { "description": "List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.", "items": { @@ -44767,6 +44785,10 @@ "description": "This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.", "type": "boolean" }, + "allowPscGlobalAccess": { + "description": "This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.", + "type": "boolean" + }, "backendService": { "description": "Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.", "type": "string" @@ -48601,6 +48623,10 @@ "networkPerformanceConfig": { "$ref": "NetworkPerformanceConfig" }, + "params": { + "$ref": "InstanceParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "postKeyRevocationActionType": { "description": "PostKeyRevocationActionType of the instance.", "enum": [ @@ -51107,6 +51133,20 @@ }, "type": "object" }, + "InstanceParams": { + "description": "Additional instance params.", + "id": "InstanceParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + } + }, + "type": "object" + }, "InstanceProperties": { "id": "InstanceProperties", "properties": { @@ -51225,8 +51265,15 @@ "$ref": "ReservationAffinity", "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet." }, + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + }, "resourcePolicies": { - "description": "Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", + "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", "items": { "type": "string" }, @@ -51904,6 +51951,10 @@ "description": "[Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, + "resourceStatus": { + "$ref": "InstantSnapshotResourceStatus", + "description": "[Output Only] Status information for the instant snapshot resource." + }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" @@ -52222,6 +52273,17 @@ }, "type": "object" }, + "InstantSnapshotResourceStatus": { + "id": "InstantSnapshotResourceStatus", + "properties": { + "storageSizeBytes": { + "description": "[Output Only] The storage size of this instant snapshot.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "InstantSnapshotsExportRequest": { "id": "InstantSnapshotsExportRequest", "properties": { @@ -56881,7 +56943,7 @@ "type": "string" }, "internalIpv6PrefixLength": { - "description": "[Output Only] The prefix length of the primary internal IPv6 range.", + "description": "The prefix length of the primary internal IPv6 range.", "format": "int32", "type": "integer" }, @@ -56907,7 +56969,7 @@ "type": "string" }, "ipv6Address": { - "description": "[Output Only] An IPv6 internal network address for this network interface.", + "description": "An IPv6 internal network address for this network interface.", "type": "string" }, "kind": { @@ -57797,7 +57859,7 @@ }, "type": "array" }, - "instanceConsumptionDatas": { + "instanceConsumptionData": { "description": "Instance data that shows consumed resources on the node.", "items": { "$ref": "InstanceConsumptionData" @@ -61997,6 +62059,7 @@ "EXTERNAL_VPN_GATEWAYS", "FIREWALLS", "FORWARDING_RULES", + "GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES", "GLOBAL_INTERNAL_ADDRESSES", "GPUS_ALL_REGIONS", "HEALTH_CHECKS", @@ -62211,6 +62274,7 @@ "", "", "", + "", "The total number of snapshots allowed for a single project.", "", "", @@ -68230,7 +68294,7 @@ "type": "string" }, "domainNames": { - "description": "If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com\".", + "description": "If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1.", "items": { "type": "string" }, @@ -69025,6 +69089,18 @@ "$ref": "CustomerEncryptionKey", "description": "Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later." }, + "snapshotType": { + "description": "Indicates the type of the snapshot.", + "enum": [ + "ARCHIVE", + "STANDARD" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "sourceDisk": { "description": "The source disk used to create this snapshot.", "type": "string" @@ -70544,7 +70620,7 @@ "type": "string" }, "ipv6CidrRange": { - "description": "[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork.", + "description": "[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually.", "type": "string" }, "kind": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 4f477c9474f..6913ec034f7 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -2458,7 +2458,7 @@ ] }, "createSnapshot": { - "description": "Creates a snapshot of a specified persistent disk.", + "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", "httpMethod": "POST", "id": "compute.disks.createSnapshot", @@ -3002,7 +3002,7 @@ ] }, "update": { - "description": "Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.", + "description": "Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.disks.update", @@ -5900,7 +5900,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -5966,7 +5966,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -6063,7 +6063,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -17312,7 +17312,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -17378,7 +17378,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -17475,7 +17475,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -17589,7 +17589,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -17671,7 +17671,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -17784,7 +17784,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -19160,7 +19160,7 @@ ] }, "createSnapshot": { - "description": "Creates a snapshot of this regional disk.", + "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", "httpMethod": "POST", "id": "compute.regionDisks.createSnapshot", @@ -22107,7 +22107,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -22189,7 +22189,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -22537,7 +22537,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -22626,7 +22626,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -23077,7 +23077,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -23166,7 +23166,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -23272,7 +23272,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -23322,7 +23322,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -26215,7 +26215,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -26353,7 +26353,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -26458,7 +26458,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -26692,7 +26692,7 @@ ] }, "insert": { - "description": "Creates a snapshot in the specified project using the data included in the request.", + "description": "Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/global/snapshots", "httpMethod": "POST", "id": "compute.snapshots.insert", @@ -26974,7 +26974,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -27047,7 +27047,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -28093,7 +28093,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -28166,7 +28166,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -28256,7 +28256,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -28563,7 +28563,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -28912,7 +28912,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -32620,7 +32620,7 @@ } } }, - "revision": "20211130", + "revision": "20211208", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -33028,11 +33028,11 @@ "id": "AccessConfig", "properties": { "externalIpv6": { - "description": "[Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.", + "description": "The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.", "type": "string" }, "externalIpv6PrefixLength": { - "description": "[Output Only] The prefix length of the external IPv6 range.", + "description": "The prefix length of the external IPv6 range.", "format": "int32", "type": "integer" }, @@ -33854,6 +33854,13 @@ "description": "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.", "type": "object" }, + "licenses": { + "description": "A list of publicly visible licenses. Reserved for Google's use.", + "items": { + "type": "string" + }, + "type": "array" + }, "multiWriter": { "description": "Indicates whether or not the disk can be read/write attached to more than one instance.", "type": "boolean" @@ -42308,6 +42315,10 @@ "networkPerformanceConfig": { "$ref": "NetworkPerformanceConfig" }, + "params": { + "$ref": "InstanceParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "postKeyRevocationActionType": { "description": "PostKeyRevocationActionType of the instance.", "enum": [ @@ -44516,6 +44527,20 @@ }, "type": "object" }, + "InstanceParams": { + "description": "Additional instance params.", + "id": "InstanceParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + } + }, + "type": "object" + }, "InstanceProperties": { "id": "InstanceProperties", "properties": { @@ -44620,8 +44645,15 @@ "$ref": "ReservationAffinity", "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet." }, + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.", + "type": "object" + }, "resourcePolicies": { - "description": "Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", + "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", "items": { "type": "string" }, @@ -45414,6 +45446,13 @@ ], "type": "string" }, + "candidateIpv6Subnets": { + "description": "Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected.", + "items": { + "type": "string" + }, + "type": "array" + }, "candidateSubnets": { "description": "Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.", "items": { @@ -45425,6 +45464,14 @@ "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", "type": "string" }, + "cloudRouterIpv6Address": { + "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", + "type": "string" + }, + "cloudRouterIpv6InterfaceId": { + "description": "If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet.", + "type": "string" + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -45433,6 +45480,14 @@ "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", "type": "string" }, + "customerRouterIpv6Address": { + "description": "[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", + "type": "string" + }, + "customerRouterIpv6InterfaceId": { + "description": "If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet.", + "type": "string" + }, "dataplaneVersion": { "description": "[Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.", "format": "int32", @@ -45560,6 +45615,18 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "stackType": { + "description": "The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "The interconnect attachment can have both IPv4 and IPv6 addresses.", + "The interconnect attachment will only be assigned IPv4 addresses." + ], + "type": "string" + }, "state": { "description": "[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. ", "enum": [ @@ -48834,7 +48901,7 @@ "type": "string" }, "ipv6Address": { - "description": "[Output Only] An IPv6 internal network address for this network interface.", + "description": "An IPv6 internal network address for this network interface.", "type": "string" }, "kind": { @@ -53378,6 +53445,7 @@ "EXTERNAL_VPN_GATEWAYS", "FIREWALLS", "FORWARDING_RULES", + "GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES", "GLOBAL_INTERNAL_ADDRESSES", "GPUS_ALL_REGIONS", "HEALTH_CHECKS", @@ -53575,6 +53643,7 @@ "", "", "", + "", "The total number of snapshots allowed for a single project.", "", "", @@ -58795,6 +58864,13 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "domainNames": { + "description": "If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1.", + "items": { + "type": "string" + }, + "type": "array" + }, "enableProxyProtocol": { "description": "If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.", "type": "boolean" @@ -60751,7 +60827,7 @@ "type": "string" }, "ipv6CidrRange": { - "description": "[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork.", + "description": "[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually.", "type": "string" }, "kind": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 0c9e77e180b..119ee0675c8 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -2084,7 +2084,7 @@ ] }, "createSnapshot": { - "description": "Creates a snapshot of a specified persistent disk.", + "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", "httpMethod": "POST", "id": "compute.disks.createSnapshot", @@ -5268,7 +5268,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -5334,7 +5334,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -5431,7 +5431,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -15306,7 +15306,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -15372,7 +15372,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -15469,7 +15469,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -15583,7 +15583,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -15665,7 +15665,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -15778,7 +15778,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -16872,7 +16872,7 @@ ] }, "createSnapshot": { - "description": "Creates a snapshot of this regional disk.", + "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", "httpMethod": "POST", "id": "compute.regionDisks.createSnapshot", @@ -19430,7 +19430,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -19512,7 +19512,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -19814,7 +19814,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -19903,7 +19903,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -20262,7 +20262,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -20351,7 +20351,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -20457,7 +20457,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -20507,7 +20507,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -23079,7 +23079,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -23217,7 +23217,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -23322,7 +23322,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -23556,7 +23556,7 @@ ] }, "insert": { - "description": "Creates a snapshot in the specified project using the data included in the request.", + "description": "Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/global/snapshots", "httpMethod": "POST", "id": "compute.snapshots.insert", @@ -23838,7 +23838,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -23911,7 +23911,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -24876,7 +24876,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -24949,7 +24949,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -25039,7 +25039,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -25308,7 +25308,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -25619,7 +25619,7 @@ "type": "string" }, "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -28809,7 +28809,7 @@ } } }, - "revision": "20211130", + "revision": "20211208", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -29217,11 +29217,11 @@ "id": "AccessConfig", "properties": { "externalIpv6": { - "description": "[Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.", + "description": "The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.", "type": "string" }, "externalIpv6PrefixLength": { - "description": "[Output Only] The prefix length of the external IPv6 range.", + "description": "The prefix length of the external IPv6 range.", "format": "int32", "type": "integer" }, @@ -29998,6 +29998,13 @@ "description": "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.", "type": "object" }, + "licenses": { + "description": "A list of publicly visible licenses. Reserved for Google's use.", + "items": { + "type": "string" + }, + "type": "array" + }, "onUpdateAction": { "description": "Specifies which action to take on instance update with this disk. Default is to use the existing disk.", "enum": [ @@ -40480,7 +40487,7 @@ "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet." }, "resourcePolicies": { - "description": "Resource policies (names, not ULRs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", + "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", "items": { "type": "string" }, @@ -41200,6 +41207,13 @@ ], "type": "string" }, + "candidateIpv6Subnets": { + "description": "Up to 16 candidate prefixes that control the allocation of cloudRouterIpv6Address and customerRouterIpv6Address for this attachment. Each prefix must be in the Global Unique Address (GUA) space. It is highly recommended that it be in a range owned by the requestor. A GUA in a range owned by Google will cause the request to fail. Google will select an available prefix from the supplied candidates or fail the request. If not supplied, a /125 from a Google-owned GUA block will be selected.", + "items": { + "type": "string" + }, + "type": "array" + }, "candidateSubnets": { "description": "Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.", "items": { @@ -41211,6 +41225,14 @@ "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", "type": "string" }, + "cloudRouterIpv6Address": { + "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", + "type": "string" + }, + "cloudRouterIpv6InterfaceId": { + "description": "If supplied, the interface id (index within the subnet) to be used for the cloud router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet.", + "type": "string" + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -41219,6 +41241,14 @@ "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", "type": "string" }, + "customerRouterIpv6Address": { + "description": "[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", + "type": "string" + }, + "customerRouterIpv6InterfaceId": { + "description": "If supplied, the interface id (index within the subnet) to be used for the customer router address. The id must be in the range of 1 to 6. If a subnet mask is supplied, it must be /125, and the subnet should either be 0 or match the selected subnet.", + "type": "string" + }, "dataplaneVersion": { "description": "[Output only for types PARTNER and DEDICATED. Not present for PARTNER_PROVIDER.] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.", "format": "int32", @@ -41334,6 +41364,18 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "stackType": { + "description": "The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "The interconnect attachment can have both IPv4 and IPv6 addresses.", + "The interconnect attachment will only be assigned IPv4 addresses." + ], + "type": "string" + }, "state": { "description": "[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. ", "enum": [ @@ -43896,6 +43938,7 @@ "INTERNET_FQDN_PORT", "INTERNET_IP_PORT", "NON_GCP_PRIVATE_IP_PORT", + "PRIVATE_SERVICE_CONNECT", "SERVERLESS" ], "enumDescriptions": [ @@ -43904,10 +43947,15 @@ "The network endpoint is represented by fully qualified domain name and port.", "The network endpoint is represented by an internet IP address and port.", "The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", + "The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect", "The network endpoint is handled by specified serverless infrastructure." ], "type": "string" }, + "pscTargetService": { + "description": "The target service url used to set up private service connection to a Google API. An example value is: \"asia-northeast3-cloudkms.googleapis.com\"", + "type": "string" + }, "region": { "description": "[Output Only] The URL of the region where the network endpoint group is located.", "type": "string" @@ -44536,7 +44584,7 @@ "type": "string" }, "ipv6Address": { - "description": "[Output Only] An IPv6 internal network address for this network interface.", + "description": "An IPv6 internal network address for this network interface.", "type": "string" }, "kind": { @@ -48986,6 +49034,7 @@ "EXTERNAL_VPN_GATEWAYS", "FIREWALLS", "FORWARDING_RULES", + "GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES", "GLOBAL_INTERNAL_ADDRESSES", "GPUS_ALL_REGIONS", "HEALTH_CHECKS", @@ -49181,6 +49230,7 @@ "", "", "", + "", "The total number of snapshots allowed for a single project.", "", "", @@ -54177,6 +54227,13 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "domainNames": { + "description": "If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1.", + "items": { + "type": "string" + }, + "type": "array" + }, "enableProxyProtocol": { "description": "If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.", "type": "boolean" @@ -56000,7 +56057,7 @@ "type": "string" }, "ipv6CidrRange": { - "description": "[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork.", + "description": "[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Note this will be for private google access only eventually.", "type": "string" }, "kind": { diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 2cb7bc03be7..bf0b81a1087 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -290,8 +290,8 @@ ], "enumDescriptions": [ "Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest.", - "Transcript field is not populated in the response.", - "All fields are populated." + "Transcript field is not populated in the response for Insights conversation.", + "All fields are populated for Insights conversation." ], "location": "query", "type": "string" @@ -346,8 +346,8 @@ ], "enumDescriptions": [ "Not specified. Defaults to FULL on GetConversationRequest and BASIC for ListConversationsRequest.", - "Transcript field is not populated in the response.", - "All fields are populated." + "Transcript field is not populated in the response for Insights conversation.", + "All fields are populated for Insights conversation." ], "location": "query", "type": "string" @@ -1123,7 +1123,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -1526,6 +1526,10 @@ "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, + "obfuscatedUserId": { + "description": "Obfuscated user ID which the customer sent to us.", + "type": "string" + }, "runtimeAnnotations": { "description": "Output only. The annotations that were generated during the customer and agent interaction.", "items": { diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index ba4df86c9c0..984bc66b7ce 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2459,7 +2459,7 @@ } } }, - "revision": "20211104", + "revision": "20211203", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3189,6 +3189,10 @@ "$ref": "ResourceUsageExportConfig", "description": "The desired configuration for exporting resource usage." }, + "desiredServiceExternalIpsConfig": { + "$ref": "ServiceExternalIPsConfig", + "description": "ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field." + }, "desiredShieldedNodes": { "$ref": "ShieldedNodes", "description": "Configuration for Shielded Nodes." @@ -3415,6 +3419,32 @@ "properties": {}, "type": "object" }, + "Filter": { + "description": "Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent", + "id": "Filter", + "properties": { + "eventType": { + "description": "Event types to allowlist.", + "items": { + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "UPGRADE_AVAILABLE_EVENT", + "UPGRADE_EVENT", + "SECURITY_BULLETIN_EVENT" + ], + "enumDescriptions": [ + "Not set, will be ignored.", + "Corresponds with UpgradeAvailableEvent.", + "Corresponds with UpgradeEvent.", + "Corresponds with SecurityBulletinEvent." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GcePersistentDiskCsiDriverConfig": { "description": "Configuration for the Compute Engine PD CSI driver.", "id": "GcePersistentDiskCsiDriverConfig", @@ -3831,6 +3861,27 @@ }, "type": "object" }, + "MaintenanceExclusionOptions": { + "description": "Represents the Maintenance exclusion option.", + "id": "MaintenanceExclusionOptions", + "properties": { + "scope": { + "description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.", + "enum": [ + "NO_UPGRADES", + "NO_MINOR_UPGRADES", + "NO_MINOR_OR_NODE_UPGRADES" + ], + "enumDescriptions": [ + "NO_UPGRADES excludes all upgrades, including patch upgrades and minor upgrades across control planes and nodes. This is the default exclusion behavior.", + "NO_MINOR_UPGRADES excludes all minor upgrades for the cluster, only patches are allowed.", + "NO_MINOR_OR_NODE_UPGRADES excludes all minor upgrades for the cluster, and also exclude all node pool upgrades. Only control plane patches are allowed." + ], + "type": "string" + } + }, + "type": "object" + }, "MaintenancePolicy": { "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.", "id": "MaintenancePolicy", @@ -4052,6 +4103,10 @@ ], "type": "string" }, + "serviceExternalIpsConfig": { + "$ref": "ServiceExternalIPsConfig", + "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not." + }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "type": "string" @@ -4244,7 +4299,7 @@ "type": "string" }, "cpuManagerPolicy": { - "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - \"none\": the default, which represents the existing scheduling behavior. - \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", + "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", "type": "string" } }, @@ -4690,6 +4745,10 @@ "description": "Enable notifications for Pub/Sub.", "type": "boolean" }, + "filter": { + "$ref": "Filter", + "description": "Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent" + }, "topic": { "description": "The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.", "type": "string" @@ -4889,6 +4948,62 @@ }, "type": "object" }, + "SecurityBulletinEvent": { + "description": "SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.", + "id": "SecurityBulletinEvent", + "properties": { + "affectedSupportedMinors": { + "description": "The GKE minor versions affected by this vulnerability.", + "items": { + "type": "string" + }, + "type": "array" + }, + "briefDescription": { + "description": "A brief description of the bulletin. See the bulletin pointed to by the bulletin_uri field for an expanded description.", + "type": "string" + }, + "bulletinId": { + "description": "The ID of the bulletin corresponding to the vulnerability.", + "type": "string" + }, + "bulletinUri": { + "description": "The URI link to the bulletin on the website for more information.", + "type": "string" + }, + "cveIds": { + "description": "The CVEs associated with this bulletin.", + "items": { + "type": "string" + }, + "type": "array" + }, + "manualStepsRequired": { + "description": "If this field is specified, it means there are manual steps that the user must take to make their clusters safe.", + "type": "boolean" + }, + "patchedVersions": { + "description": "The GKE versions where this vulnerability is patched.", + "items": { + "type": "string" + }, + "type": "array" + }, + "resourceTypeAffected": { + "description": "The resource type (node/control plane) that has the vulnerability. Multiple notifications (1 notification per resource type) will be sent for a vulnerability that affects > 1 resource type.", + "type": "string" + }, + "severity": { + "description": "The severity of this bulletin as it relates to GKE.", + "type": "string" + }, + "suggestedUpgradeTarget": { + "description": "This represents a version selected from the patched_versions field that the cluster receiving this notification should most likely want to upgrade to based on its current version. Note that if this notification is being received by a given cluster, it means that this version is currently available as an upgrade target in that cluster's location.", + "type": "string" + } + }, + "type": "object" + }, "ServerConfig": { "description": "Kubernetes Engine service configuration.", "id": "ServerConfig", @@ -4932,6 +5047,17 @@ }, "type": "object" }, + "ServiceExternalIPsConfig": { + "description": "Config to block services with externalIPs field.", + "id": "ServiceExternalIPsConfig", + "properties": { + "enabled": { + "description": "Whether Services with ExternalIPs field are allowed or not.", + "type": "boolean" + } + }, + "type": "object" + }, "SetAddonsConfigRequest": { "description": "SetAddonsConfigRequest sets the addons associated with the cluster.", "id": "SetAddonsConfigRequest", @@ -5459,6 +5585,10 @@ "format": "google-datetime", "type": "string" }, + "maintenanceExclusionOptions": { + "$ref": "MaintenanceExclusionOptions", + "description": "MaintenanceExclusionOptions provides maintenance exclusion related options." + }, "startTime": { "description": "The time that the window first starts.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index a9ad8a557e4..5fe097bbfa5 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2484,7 +2484,7 @@ } } }, - "revision": "20211104", + "revision": "20211203", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3203,7 +3203,7 @@ }, "desiredGcfsConfig": { "$ref": "GcfsConfig", - "description": "The desired GCFS config for the cluster" + "description": "The desired GCFS config for the cluster." }, "desiredIdentityServiceConfig": { "$ref": "IdentityServiceConfig", @@ -3582,6 +3582,32 @@ }, "type": "object" }, + "Filter": { + "description": "Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent", + "id": "Filter", + "properties": { + "eventType": { + "description": "Event types to allowlist.", + "items": { + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "UPGRADE_AVAILABLE_EVENT", + "UPGRADE_EVENT", + "SECURITY_BULLETIN_EVENT" + ], + "enumDescriptions": [ + "Not set, will be ignored.", + "Corresponds with UpgradeAvailableEvent.", + "Corresponds with UpgradeEvent.", + "Corresponds with SecurityBulletinEvent." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GcePersistentDiskCsiDriverConfig": { "description": "Configuration for the Compute Engine PD CSI driver.", "id": "GcePersistentDiskCsiDriverConfig", @@ -4094,6 +4120,27 @@ }, "type": "object" }, + "MaintenanceExclusionOptions": { + "description": "Represents the Maintenance exclusion option.", + "id": "MaintenanceExclusionOptions", + "properties": { + "scope": { + "description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.", + "enum": [ + "NO_UPGRADES", + "NO_MINOR_UPGRADES", + "NO_MINOR_OR_NODE_UPGRADES" + ], + "enumDescriptions": [ + "NO_UPGRADES excludes all upgrades, including patch upgrades and minor upgrades across control planes and nodes. This is the default exclusion behavior.", + "NO_MINOR_UPGRADES excludes all minor upgrades for the cluster, only patches are allowed.", + "NO_MINOR_OR_NODE_UPGRADES excludes all minor upgrades for the cluster, and also exclude all node pool upgrades. Only control plane patches are allowed." + ], + "type": "string" + } + }, + "type": "object" + }, "MaintenancePolicy": { "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.", "id": "MaintenancePolicy", @@ -4555,7 +4602,7 @@ "type": "string" }, "cpuManagerPolicy": { - "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - \"none\": the default, which represents the existing scheduling behavior. - \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", + "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", "type": "string" } }, @@ -5040,6 +5087,10 @@ "description": "Enable notifications for Pub/Sub.", "type": "boolean" }, + "filter": { + "$ref": "Filter", + "description": "Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent" + }, "topic": { "description": "The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.", "type": "string" @@ -5250,6 +5301,62 @@ }, "type": "object" }, + "SecurityBulletinEvent": { + "description": "SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.", + "id": "SecurityBulletinEvent", + "properties": { + "affectedSupportedMinors": { + "description": "The GKE minor versions affected by this vulnerability.", + "items": { + "type": "string" + }, + "type": "array" + }, + "briefDescription": { + "description": "A brief description of the bulletin. See the bulletin pointed to by the bulletin_uri field for an expanded description.", + "type": "string" + }, + "bulletinId": { + "description": "The ID of the bulletin corresponding to the vulnerability.", + "type": "string" + }, + "bulletinUri": { + "description": "The URI link to the bulletin on the website for more information.", + "type": "string" + }, + "cveIds": { + "description": "The CVEs associated with this bulletin.", + "items": { + "type": "string" + }, + "type": "array" + }, + "manualStepsRequired": { + "description": "If this field is specified, it means there are manual steps that the user must take to make their clusters safe.", + "type": "boolean" + }, + "patchedVersions": { + "description": "The GKE versions where this vulnerability is patched.", + "items": { + "type": "string" + }, + "type": "array" + }, + "resourceTypeAffected": { + "description": "The resource type (node/control plane) that has the vulnerability. Multiple notifications (1 notification per resource type) will be sent for a vulnerability that affects > 1 resource type.", + "type": "string" + }, + "severity": { + "description": "The severity of this bulletin as it relates to GKE.", + "type": "string" + }, + "suggestedUpgradeTarget": { + "description": "This represents a version selected from the patched_versions field that the cluster receiving this notification should most likely want to upgrade to based on its current version. Note that if this notification is being received by a given cluster, it means that this version is currently available as an upgrade target in that cluster's location.", + "type": "string" + } + }, + "type": "object" + }, "ServerConfig": { "description": "Kubernetes Engine service configuration.", "id": "ServerConfig", @@ -5838,6 +5945,10 @@ "format": "google-datetime", "type": "string" }, + "maintenanceExclusionOptions": { + "$ref": "MaintenanceExclusionOptions", + "description": "MaintenanceExclusionOptions provides maintenance exclusion related options." + }, "startTime": { "description": "The time that the window first starts.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index fd26561e470..818add5ec21 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -105,129 +105,6 @@ }, "protocol": "rest", "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "containeranalysis.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "request": { - "$ref": "CancelOperationRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "containeranalysis.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/operations/{operationsId}", - "httpMethod": "GET", - "id": "containeranalysis.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "flatPath": "v1/operations", - "httpMethod": "GET", - "id": "containeranalysis.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^operations$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "projects": { "resources": { "notes": { @@ -878,7 +755,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -1159,6 +1036,158 @@ }, "type": "object" }, + "CVSS": { + "description": "Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score.", + "id": "CVSS", + "properties": { + "attackComplexity": { + "enum": [ + "ATTACK_COMPLEXITY_UNSPECIFIED", + "ATTACK_COMPLEXITY_LOW", + "ATTACK_COMPLEXITY_HIGH" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "attackVector": { + "description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.", + "enum": [ + "ATTACK_VECTOR_UNSPECIFIED", + "ATTACK_VECTOR_NETWORK", + "ATTACK_VECTOR_ADJACENT", + "ATTACK_VECTOR_LOCAL", + "ATTACK_VECTOR_PHYSICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "authentication": { + "enum": [ + "AUTHENTICATION_UNSPECIFIED", + "AUTHENTICATION_MULTIPLE", + "AUTHENTICATION_SINGLE", + "AUTHENTICATION_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "availabilityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "baseScore": { + "description": "The base score is a function of the base metric scores.", + "format": "float", + "type": "number" + }, + "confidentialityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "exploitabilityScore": { + "format": "float", + "type": "number" + }, + "impactScore": { + "format": "float", + "type": "number" + }, + "integrityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "privilegesRequired": { + "enum": [ + "PRIVILEGES_REQUIRED_UNSPECIFIED", + "PRIVILEGES_REQUIRED_NONE", + "PRIVILEGES_REQUIRED_LOW", + "PRIVILEGES_REQUIRED_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "scope": { + "enum": [ + "SCOPE_UNSPECIFIED", + "SCOPE_UNCHANGED", + "SCOPE_CHANGED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "userInteraction": { + "enum": [ + "USER_INTERACTION_UNSPECIFIED", + "USER_INTERACTION_NONE", + "USER_INTERACTION_REQUIRED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "CVSSv3": { "description": "Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document", "id": "CVSSv3", @@ -1296,12 +1325,6 @@ }, "type": "object" }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, - "type": "object" - }, "Category": { "description": "The category to which the update belongs.", "id": "Category", @@ -3204,24 +3227,6 @@ }, "type": "object" }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" - }, - "type": "array" - } - }, - "type": "object" - }, "Location": { "description": "An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.", "id": "Location", @@ -3529,41 +3534,6 @@ }, "type": "object" }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, "PackageIssue": { "description": "A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).", "id": "PackageIssue", @@ -4224,6 +4194,10 @@ "format": "float", "type": "number" }, + "cvssv3": { + "$ref": "CVSS", + "description": "The cvss v3 score for the vulnerability." + }, "effectiveSeverity": { "description": "The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 5813d994653..9c0eeec83a0 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1229,7 +1229,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "Artifact": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index e757490eac2..69b4f44eaeb 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -853,7 +853,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index f00c62f00b8..1fc3e4feea9 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -674,7 +674,7 @@ } } }, - "revision": "20211203", + "revision": "20211230", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1.json index da0fe2476a2..29db0d333a2 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1.json @@ -607,6 +607,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "star": { + "description": "Marks an Entry as starred by the current user. Starring information is private to each user.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:star", + "httpMethod": "POST", + "id": "datacatalog.projects.locations.entryGroups.entries.star", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the entry to mark as starred.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:star", + "request": { + "$ref": "GoogleCloudDatacatalogV1StarEntryRequest" + }, + "response": { + "$ref": "GoogleCloudDatacatalogV1StarEntryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "testIamPermissions": { "description": "Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:testIamPermissions", @@ -634,13 +662,41 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "unstar": { + "description": "Marks an Entry as NOT starred by the current user. Starring information is private to each user.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:unstar", + "httpMethod": "POST", + "id": "datacatalog.projects.locations.entryGroups.entries.unstar", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the entry to mark as **not** starred.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:unstar", + "request": { + "$ref": "GoogleCloudDatacatalogV1UnstarEntryRequest" + }, + "response": { + "$ref": "GoogleCloudDatacatalogV1UnstarEntryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "tags": { "methods": { "create": { - "description": "Creates a tag and assigns it to: * An Entry if the method name is ``projects.locations.entryGroups.entries.tags.create``. * Or EntryGroupif the method name is ``projects.locations.entryGroups.tags.create``. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.", + "description": "Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "httpMethod": "POST", "id": "datacatalog.projects.locations.entryGroups.entries.tags.create", @@ -769,7 +825,7 @@ "tags": { "methods": { "create": { - "description": "Creates a tag and assigns it to: * An Entry if the method name is ``projects.locations.entryGroups.entries.tags.create``. * Or EntryGroupif the method name is ``projects.locations.entryGroups.tags.create``. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.", + "description": "Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "httpMethod": "POST", "id": "datacatalog.projects.locations.entryGroups.tags.create", @@ -1030,7 +1086,7 @@ "type": "string" }, "updateMask": { - "description": "Names of fields whose values to overwrite on a tag template. Currently, only `display_name` and `is_publicly_readable` can be overwritten. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the ``is_publicly_readable`` field may require up to 12 hours to take effect in search results. Additionally, it also requires the ``tagTemplates.getIamPolicy`` and ``tagTemplates.setIamPolicy`` permissions.", + "description": "Names of fields whose values to overwrite on a tag template. Currently, only `display_name` and `is_publicly_readable` can be overwritten. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the `is_publicly_readable` field may require up to 12 hours to take effect in search results. Additionally, it also requires the `tagTemplates.getIamPolicy` and `tagTemplates.setIamPolicy` permissions.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1214,7 +1270,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the tag template.", + "description": "Required. The name of the tag template field.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$", "required": true, @@ -1841,7 +1897,7 @@ } } }, - "revision": "20211014", + "revision": "20211201", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -1911,7 +1967,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -2220,6 +2276,11 @@ "readOnly": true, "type": "string" }, + "personalDetails": { + "$ref": "GoogleCloudDatacatalogV1PersonalDetails", + "description": "Output only. Additional information related to the entry. Private to the current user.", + "readOnly": true + }, "routineSpec": { "$ref": "GoogleCloudDatacatalogV1RoutineSpec", "description": "Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type." @@ -2544,6 +2605,22 @@ }, "type": "object" }, + "GoogleCloudDatacatalogV1PersonalDetails": { + "description": "Entry metadata relevant only to the user and private to them.", + "id": "GoogleCloudDatacatalogV1PersonalDetails", + "properties": { + "starTime": { + "description": "Set if the entry is starred; unset otherwise.", + "format": "google-datetime", + "type": "string" + }, + "starred": { + "description": "True if the entry is starred by the user; false otherwise.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDatacatalogV1PolicyTag": { "description": "Denotes one policy tag in a taxonomy, for example, SSN. Policy tags can be defined in a hierarchy. For example: ``` + Geolocation + LatLong + City + ZipCode ``` Where the \"Geolocation\" policy tag contains three children.", "id": "GoogleCloudDatacatalogV1PolicyTag", @@ -2703,7 +2780,7 @@ "id": "GoogleCloudDatacatalogV1SearchCatalogRequest", "properties": { "orderBy": { - "description": "Specifies the order of results. Currently supported case-sensitive values are: * `relevance` that can only be descending * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default If this parameter is omitted, it defaults to the descending `relevance`.", + "description": "Specifies the order of results. Currently supported case-sensitive values are: * `relevance` that can only be descending * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`.", "type": "string" }, "pageSize": { @@ -2716,7 +2793,7 @@ "type": "string" }, "query": { - "description": "Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see [Data Catalog search syntax](/data-catalog/docs/how-to/search-reference). An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: * `name:x` * `column:y` * `description:z`", + "description": "Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference). An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: * `name:x` * `column:y` * `description:z`", "type": "string" }, "scope": { @@ -2749,7 +2826,7 @@ "type": "array" }, "includePublicTagTemplates": { - "description": "Optional. If `true`, include public tag templates in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner. Other scope fields, for example, ``include_org_ids``, still restrict the returned public tag templates and at least one of them is required.", + "description": "Optional. If `true`, include public tag templates in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner. Other scope fields, for example, `include_org_ids`, still restrict the returned public tag templates and at least one of them is required.", "type": "boolean" }, "restrictedLocations": { @@ -2758,6 +2835,10 @@ "type": "string" }, "type": "array" + }, + "starredOnly": { + "description": "Optional. If `true`, search only among starred entries. By default, all results are returned, starred or not.", + "type": "boolean" } }, "type": "object" @@ -2923,6 +3004,18 @@ }, "type": "object" }, + "GoogleCloudDatacatalogV1StarEntryRequest": { + "description": "Request message for StarEntry.", + "id": "GoogleCloudDatacatalogV1StarEntryRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatacatalogV1StarEntryResponse": { + "description": "Response message for StarEntry. Empty for now", + "id": "GoogleCloudDatacatalogV1StarEntryResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDatacatalogV1SystemTimestamps": { "description": "Timestamps associated with this resource in a particular system.", "id": "GoogleCloudDatacatalogV1SystemTimestamps", @@ -3149,6 +3242,18 @@ }, "type": "object" }, + "GoogleCloudDatacatalogV1UnstarEntryRequest": { + "description": "Request message for UnstarEntry.", + "id": "GoogleCloudDatacatalogV1UnstarEntryRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatacatalogV1UnstarEntryResponse": { + "description": "Response message for UnstarEntry. Empty for now", + "id": "GoogleCloudDatacatalogV1UnstarEntryResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDatacatalogV1UsageSignal": { "description": "The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.", "id": "GoogleCloudDatacatalogV1UsageSignal", diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json index 8ce78e2cb88..b6443dec64b 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json @@ -142,7 +142,7 @@ "type": "string" }, "sqlResource": { - "description": "The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.", + "description": "The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s should satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.", "location": "query", "type": "string" } @@ -688,7 +688,7 @@ ] }, "list": { - "description": "Lists the tags on an Entry.", + "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "httpMethod": "GET", "id": "datacatalog.projects.locations.entryGroups.entries.tags.list", @@ -817,7 +817,7 @@ ] }, "list": { - "description": "Lists the tags on an Entry.", + "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "httpMethod": "GET", "id": "datacatalog.projects.locations.entryGroups.tags.list", @@ -1808,7 +1808,7 @@ } } }, - "revision": "20211014", + "revision": "20211230", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -1878,7 +1878,7 @@ "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -2395,7 +2395,7 @@ "id": "GoogleCloudDatacatalogV1beta1SearchCatalogRequest", "properties": { "orderBy": { - "description": "Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified If not specified, defaults to `relevance` descending.", + "description": "Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified * `default` that can only be descending If not specified, defaults to `relevance` descending.", "type": "string" }, "pageSize": { @@ -2816,7 +2816,7 @@ "type": "object" }, "GoogleCloudDatacatalogV1beta1UsageStats": { - "description": "Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only inlude BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables", + "description": "Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables", "id": "GoogleCloudDatacatalogV1beta1UsageStats", "properties": { "totalCancellations": { diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index ff1cdad9c7c..ffd7be222aa 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -2225,7 +2225,7 @@ } } }, - "revision": "20211029", + "revision": "20211204", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json b/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json index 32bf5520477..8ce59865300 100644 --- a/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json @@ -1596,7 +1596,7 @@ } } }, - "revision": "20211106", + "revision": "20211207", "rootUrl": "https://datalabeling.googleapis.com/", "schemas": { "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 5ccd90f6577..d480b110b8b 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -287,7 +287,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -589,7 +589,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -1049,7 +1049,7 @@ } } }, - "revision": "20211103", + "revision": "20211201", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { @@ -1176,6 +1176,10 @@ "description": "[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.", "type": "boolean" }, + "cmekKeyName": { + "description": "The KMS key name used for the csql instance.", + "type": "string" + }, "collation": { "description": "The Cloud SQL default instance level collation.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index 21fdda01437..a826dfdbbbc 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -287,7 +287,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -589,7 +589,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -1049,7 +1049,7 @@ } } }, - "revision": "20211103", + "revision": "20211201", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/datapipelines.v1.json b/googleapiclient/discovery_cache/documents/datapipelines.v1.json index b523fb2c27f..8c29d81ecb1 100644 --- a/googleapiclient/discovery_cache/documents/datapipelines.v1.json +++ b/googleapiclient/discovery_cache/documents/datapipelines.v1.json @@ -110,7 +110,7 @@ "locations": { "methods": { "listPipelines": { - "description": "Lists pipelines. Returns a \"NOT_FOUND\" error if the list is empty. Returns a \"FORBIDDEN\" error if the caller doesn't have permission to access it.", + "description": "Lists pipelines. Returns a \"FORBIDDEN\" error if the caller doesn't have permission to access it.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "id": "datapipelines.projects.locations.listPipelines", @@ -119,7 +119,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `executor_type`: The type of pipeline execution layer. This is always Dataflow for now, but more executors may be added later. Allowed values are `ALL` and `DATAFLOW`. + `status`: The activity status of the pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE", + "description": "An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `status`: The activity status of the pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE", "location": "query", "type": "string" }, @@ -217,7 +217,7 @@ ], "parameters": { "name": { - "description": "Required. The pipeeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.", + "description": "Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$", "required": true, @@ -233,7 +233,7 @@ ] }, "patch": { - "description": "Updates a pipeline. If successful, the updated [Pipeline] is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.", + "description": "Updates a pipeline. If successful, the updated Pipeline is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}", "httpMethod": "PATCH", "id": "datapipelines.projects.locations.pipelines.patch", @@ -242,7 +242,7 @@ ], "parameters": { "name": { - "description": "The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.", + "description": "The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$", "required": true, @@ -267,7 +267,7 @@ ] }, "run": { - "description": "Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a \"NOT_FOUND\" error if the pipeline doesn't exist. Returns a \"FOBIDDEN\" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.", + "description": "Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a \"NOT_FOUND\" error if the pipeline doesn't exist. Returns a \"FORBIDDEN\" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run", "httpMethod": "POST", "id": "datapipelines.projects.locations.pipelines.run", @@ -295,7 +295,7 @@ ] }, "stop": { - "description": "Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to \"ARCHIVED\". However, pipeline metadata is retained. Upon success, the pipeline state is updated to ARCHIVED.", + "description": "Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to \"ARCHIVED\". However, pipeline metadata is retained.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop", "httpMethod": "POST", "id": "datapipelines.projects.locations.pipelines.stop", @@ -329,7 +329,7 @@ } } }, - "revision": "20211105", + "revision": "20211203", "rootUrl": "https://datapipelines.googleapis.com/", "schemas": { "GoogleCloudDatapipelinesV1DataflowJobDetails": { @@ -659,7 +659,7 @@ "type": "object" }, "GoogleCloudDatapipelinesV1Pipeline": { - "description": "The main pipeline entity and all the needed metadata to launch and manage linked jobs.", + "description": "The main pipeline entity and all the necessary metadata for launching and managing linked jobs.", "id": "GoogleCloudDatapipelinesV1Pipeline", "properties": { "createTime": { @@ -685,7 +685,7 @@ "type": "string" }, "name": { - "description": "The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.", + "description": "The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and 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 pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.", "type": "string" }, "pipelineSources": { diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 1bcbcd7f8a1..b0a0ce72077 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -2316,7 +2316,7 @@ } } }, - "revision": "20211111", + "revision": "20211209", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index 123da34e2cd..45af792b69b 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -626,7 +626,7 @@ } } }, - "revision": "20211029", + "revision": "20211206", "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 32b180c6986..57850b7df45 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json @@ -168,7 +168,7 @@ } } }, - "revision": "20211029", + "revision": "20211206", "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 4d390f20174..8eecbfce87b 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json @@ -308,7 +308,7 @@ } } }, - "revision": "20211029", + "revision": "20211206", "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 2aebbfaf5a5..128e996253d 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1588,7 +1588,7 @@ } } }, - "revision": "20211111", + "revision": "20211209", "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 96a663c09df..e8b93b097fa 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -988,7 +988,7 @@ } } }, - "revision": "20211111", + "revision": "20211209", "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 cc12014dca9..2c22c6d2bfe 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1552,7 +1552,7 @@ } } }, - "revision": "20211111", + "revision": "20211209", "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 f09a828e685..a864e4b1d4e 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -6983,7 +6983,7 @@ } } }, - "revision": "20211201", + "revision": "20211216", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -13733,7 +13733,7 @@ "id": "GoogleCloudDialogflowV2SpeechToTextConfig", "properties": { "speechModelVariant": { - "description": "Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request.", + "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ "SPEECH_MODEL_VARIANT_UNSPECIFIED", "USE_BEST_AVAILABLE", @@ -15756,6 +15756,10 @@ "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { + "knowledgeBase": { + "description": "The name of the knowledge base interacted with during the operation.", + "type": "string" + }, "state": { "description": "Required. Output only. The current state of this operation.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 17ec5545453..9c8581679c1 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -7315,7 +7315,7 @@ } } }, - "revision": "20211201", + "revision": "20211216", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -15518,6 +15518,10 @@ "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { + "knowledgeBase": { + "description": "The name of the knowledge base interacted with during the operation.", + "type": "string" + }, "state": { "description": "Required. Output only. The current state of this operation.", "enum": [ @@ -16448,7 +16452,7 @@ "id": "GoogleCloudDialogflowV2beta1SpeechToTextConfig", "properties": { "speechModelVariant": { - "description": "Optional. The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request.", + "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ "SPEECH_MODEL_VARIANT_UNSPECIFIED", "USE_BEST_AVAILABLE", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 980d76c25e4..1498b38dd21 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -3820,7 +3820,7 @@ } } }, - "revision": "20211201", + "revision": "20211216", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -12787,6 +12787,10 @@ "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { + "knowledgeBase": { + "description": "The name of the knowledge base interacted with during the operation.", + "type": "string" + }, "state": { "description": "Required. Output only. The current state of this operation.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 2f654ddb5d6..5a04b897105 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -3820,7 +3820,7 @@ } } }, - "revision": "20211201", + "revision": "20211216", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -12787,6 +12787,10 @@ "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { + "knowledgeBase": { + "description": "The name of the knowledge base interacted with during the operation.", + "type": "string" + }, "state": { "description": "Required. Output only. The current state of this operation.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json index 45bd2449037..3da9d199e60 100644 --- a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +++ b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json @@ -184,7 +184,7 @@ } } }, - "revision": "20211125", + "revision": "20211228", "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 b2da9156993..ea627dded09 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v1.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v1.json @@ -7635,7 +7635,7 @@ } } }, - "revision": "20211206", + "revision": "20211210", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index a933385c8d7..1e88143d683 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -3412,7 +3412,7 @@ } } }, - "revision": "20211112", + "revision": "20211204", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -3566,6 +3566,13 @@ }, "type": "array" }, + "includedFields": { + "description": "Limit scanning only to these fields.", + "items": { + "$ref": "GooglePrivacyDlpV2FieldId" + }, + "type": "array" + }, "rowsLimit": { "description": "Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index c0ba1f07f68..ee64fdd6dfd 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1233,9 +1233,507 @@ ] } } + }, + "responsePolicies": { + "methods": { + "create": { + "description": "Creates a new Response Policy", + "flatPath": "dns/v1/projects/{project}/responsePolicies", + "httpMethod": "POST", + "id": "dns.responsePolicies.create", + "parameterOrder": [ + "project" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies", + "request": { + "$ref": "ResponsePolicy" + }, + "response": { + "$ref": "ResponsePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "delete": { + "description": "Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "httpMethod": "DELETE", + "id": "dns.responsePolicies.delete", + "parameterOrder": [ + "project", + "responsePolicy" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "get": { + "description": "Fetches the representation of an existing Response Policy.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "httpMethod": "GET", + "id": "dns.responsePolicies.get", + "parameterOrder": [ + "project", + "responsePolicy" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "response": { + "$ref": "ResponsePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/ndev.clouddns.readonly", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "list": { + "description": "Enumerates all Response Policies associated with a project.", + "flatPath": "dns/v1/projects/{project}/responsePolicies", + "httpMethod": "GET", + "id": "dns.responsePolicies.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "maxResults": { + "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies", + "response": { + "$ref": "ResponsePoliciesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/ndev.clouddns.readonly", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "patch": { + "description": "Applies a partial update to an existing Response Policy.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "httpMethod": "PATCH", + "id": "dns.responsePolicies.patch", + "parameterOrder": [ + "project", + "responsePolicy" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Respones Policy addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "request": { + "$ref": "ResponsePolicy" + }, + "response": { + "$ref": "ResponsePoliciesPatchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "update": { + "description": "Updates an existing Response Policy.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "httpMethod": "PUT", + "id": "dns.responsePolicies.update", + "parameterOrder": [ + "project", + "responsePolicy" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}", + "request": { + "$ref": "ResponsePolicy" + }, + "response": { + "$ref": "ResponsePoliciesUpdateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + } + } + }, + "responsePolicyRules": { + "methods": { + "create": { + "description": "Creates a new Response Policy Rule.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules", + "httpMethod": "POST", + "id": "dns.responsePolicyRules.create", + "parameterOrder": [ + "project", + "responsePolicy" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy containing the Response Policy Rule.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules", + "request": { + "$ref": "ResponsePolicyRule" + }, + "response": { + "$ref": "ResponsePolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "delete": { + "description": "Deletes a previously created Response Policy Rule.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "httpMethod": "DELETE", + "id": "dns.responsePolicyRules.delete", + "parameterOrder": [ + "project", + "responsePolicy", + "responsePolicyRule" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy containing the Response Policy Rule.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicyRule": { + "description": "User assigned name of the Response Policy Rule addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "get": { + "description": "Fetches the representation of an existing Response Policy Rule.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "httpMethod": "GET", + "id": "dns.responsePolicyRules.get", + "parameterOrder": [ + "project", + "responsePolicy", + "responsePolicyRule" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy containing the Response Policy Rule.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicyRule": { + "description": "User assigned name of the Response Policy Rule addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "response": { + "$ref": "ResponsePolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/ndev.clouddns.readonly", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "list": { + "description": "Enumerates all Response Policy Rules associated with a project.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules", + "httpMethod": "GET", + "id": "dns.responsePolicyRules.list", + "parameterOrder": [ + "project", + "responsePolicy" + ], + "parameters": { + "maxResults": { + "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy to list.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules", + "response": { + "$ref": "ResponsePolicyRulesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/ndev.clouddns.readonly", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "patch": { + "description": "Applies a partial update to an existing Response Policy Rule.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "httpMethod": "PATCH", + "id": "dns.responsePolicyRules.patch", + "parameterOrder": [ + "project", + "responsePolicy", + "responsePolicyRule" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy containing the Response Policy Rule.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicyRule": { + "description": "User assigned name of the Response Policy Rule addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "request": { + "$ref": "ResponsePolicyRule" + }, + "response": { + "$ref": "ResponsePolicyRulesPatchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + }, + "update": { + "description": "Updates an existing Response Policy Rule.", + "flatPath": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "httpMethod": "PUT", + "id": "dns.responsePolicyRules.update", + "parameterOrder": [ + "project", + "responsePolicy", + "responsePolicyRule" + ], + "parameters": { + "clientOperationId": { + "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Identifies the project addressed by this request.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicy": { + "description": "User assigned name of the Response Policy containing the Response Policy Rule.", + "location": "path", + "required": true, + "type": "string" + }, + "responsePolicyRule": { + "description": "User assigned name of the Response Policy Rule addressed by this request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}", + "request": { + "$ref": "ResponsePolicyRule" + }, + "response": { + "$ref": "ResponsePolicyRulesUpdateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/ndev.clouddns.readwrite" + ] + } + } } }, - "revision": "20211202", + "revision": "20211215", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2242,6 +2740,187 @@ } }, "type": "object" + }, + "ResponsePoliciesListResponse": { + "id": "ResponsePoliciesListResponse", + "properties": { + "header": { + "$ref": "ResponseHeader" + }, + "nextPageToken": { + "description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", + "type": "string" + }, + "responsePolicies": { + "description": "The Response Policy resources.", + "items": { + "$ref": "ResponsePolicy" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResponsePoliciesPatchResponse": { + "id": "ResponsePoliciesPatchResponse", + "properties": { + "header": { + "$ref": "ResponseHeader" + }, + "responsePolicy": { + "$ref": "ResponsePolicy" + } + }, + "type": "object" + }, + "ResponsePoliciesUpdateResponse": { + "id": "ResponsePoliciesUpdateResponse", + "properties": { + "header": { + "$ref": "ResponseHeader" + }, + "responsePolicy": { + "$ref": "ResponsePolicy" + } + }, + "type": "object" + }, + "ResponsePolicy": { + "description": "A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.", + "id": "ResponsePolicy", + "properties": { + "description": { + "description": "User-provided description for this Response Policy.", + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource; defined by the server (output only).", + "format": "int64", + "type": "string" + }, + "kind": { + "default": "dns#responsePolicy", + "type": "string" + }, + "networks": { + "description": "List of network names specifying networks to which this policy is applied.", + "items": { + "$ref": "ResponsePolicyNetwork" + }, + "type": "array" + }, + "responsePolicyName": { + "description": "User assigned name for this Response Policy.", + "type": "string" + } + }, + "type": "object" + }, + "ResponsePolicyNetwork": { + "id": "ResponsePolicyNetwork", + "properties": { + "kind": { + "default": "dns#responsePolicyNetwork", + "type": "string" + }, + "networkUrl": { + "description": "The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", + "type": "string" + } + }, + "type": "object" + }, + "ResponsePolicyRule": { + "description": "A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.", + "id": "ResponsePolicyRule", + "properties": { + "behavior": { + "description": "Answer this query with a behavior rather than DNS data.", + "enum": [ + "behaviorUnspecified", + "bypassResponsePolicy" + ], + "enumDescriptions": [ + "", + "Skip a less-specific ResponsePolicyRule and continue normal query logic. This can be used in conjunction with a wildcard to exempt a subset of the wildcard ResponsePolicyRule from the ResponsePolicy behavior and e.g., query the public internet instead. For instance, if these rules exist: *.example.com -> 1.2.3.4 foo.example.com -> PASSTHRU Then a query for 'foo.example.com' skips the wildcard." + ], + "type": "string" + }, + "dnsName": { + "description": "The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.", + "type": "string" + }, + "kind": { + "default": "dns#responsePolicyRule", + "type": "string" + }, + "localData": { + "$ref": "ResponsePolicyRuleLocalData", + "description": "Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed." + }, + "ruleName": { + "description": "An identifier for this rule. Must be unique with the ResponsePolicy.", + "type": "string" + } + }, + "type": "object" + }, + "ResponsePolicyRuleLocalData": { + "id": "ResponsePolicyRuleLocalData", + "properties": { + "localDatas": { + "description": "All resource record sets for this selector, one per resource record type. The name must match the dns_name.", + "items": { + "$ref": "ResourceRecordSet" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResponsePolicyRulesListResponse": { + "id": "ResponsePolicyRulesListResponse", + "properties": { + "header": { + "$ref": "ResponseHeader" + }, + "nextPageToken": { + "description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", + "type": "string" + }, + "responsePolicyRules": { + "description": "The Response Policy Rule resources.", + "items": { + "$ref": "ResponsePolicyRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResponsePolicyRulesPatchResponse": { + "id": "ResponsePolicyRulesPatchResponse", + "properties": { + "header": { + "$ref": "ResponseHeader" + }, + "responsePolicyRule": { + "$ref": "ResponsePolicyRule" + } + }, + "type": "object" + }, + "ResponsePolicyRulesUpdateResponse": { + "id": "ResponsePolicyRulesUpdateResponse", + "properties": { + "header": { + "$ref": "ResponseHeader" + }, + "responsePolicyRule": { + "$ref": "ResponsePolicyRule" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 89d87ed345d..bcffe6f7029 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1730,7 +1730,7 @@ } } }, - "revision": "20211202", + "revision": "20211215", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index b08807e4818..48a4bd2c696 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20211202", + "revision": "20211215", "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 d57e3026a49..abfd247fd58 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -148,7 +148,7 @@ ], "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}", + "description": "Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -338,7 +338,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", "required": true, @@ -366,7 +366,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}", + "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, @@ -511,7 +511,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}", + "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, @@ -536,7 +536,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", "required": true, @@ -628,7 +628,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$", "required": true, @@ -745,7 +745,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}", + "description": "Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", "required": true, @@ -770,7 +770,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$", "required": true, @@ -1029,7 +1029,7 @@ } } }, - "revision": "20211125", + "revision": "20211214", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1592,7 +1592,7 @@ "type": "string" }, "outputGcsDestination": { - "description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.", + "description": "The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty.", "type": "string" }, "status": { @@ -1836,7 +1836,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1DocumentEntity", "properties": { "confidence": { @@ -1925,7 +1925,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -2543,11 +2543,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -2557,7 +2557,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1DocumentProvenanceParent", "properties": { "id": { @@ -2566,12 +2566,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -2607,6 +2607,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -2957,7 +2964,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1Processor": { - "description": "The first-class citizen for DAI. Each processor defines how to extract structural information from a document.", + "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", "id": "GoogleCloudDocumentaiV1Processor", "properties": { "createTime": { @@ -2978,7 +2985,7 @@ "type": "string" }, "name": { - "description": "Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}", + "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", "readOnly": true, "type": "string" }, @@ -3001,7 +3008,7 @@ ], "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 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.", @@ -3020,11 +3027,11 @@ "type": "object" }, "GoogleCloudDocumentaiV1ProcessorType": { - "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: 9.", + "description": "A processor type is responsible for performing a certain document understanding task on a certain type of document.", "id": "GoogleCloudDocumentaiV1ProcessorType", "properties": { "allowCreation": { - "description": "Whether the processor type allows creation. If yes, user can create a processor of this processor type. Otherwise, user needs to request access.", + "description": "Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.", "type": "boolean" }, "availableLocations": { @@ -3098,7 +3105,7 @@ "type": "string" }, "name": { - "description": "The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}", + "description": "The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", "type": "string" }, "state": { @@ -3156,7 +3163,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1ReviewDocumentRequest": { - "description": "Request message for review document method. Next Id: 6.", + "description": "Request message for review document method.", "id": "GoogleCloudDocumentaiV1ReviewDocumentRequest", "properties": { "enableSchemaValidation": { @@ -3371,7 +3378,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta1DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1beta1DocumentEntity", "properties": { "confidence": { @@ -3460,7 +3467,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -4056,11 +4063,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -4070,7 +4077,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", "properties": { "id": { @@ -4079,12 +4086,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -4120,6 +4127,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -4532,7 +4546,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta2DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1beta2DocumentEntity", "properties": { "confidence": { @@ -4621,7 +4635,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -5237,11 +5251,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -5251,7 +5265,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", "properties": { "id": { @@ -5260,12 +5274,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -5301,6 +5315,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -5668,7 +5689,7 @@ "type": "string" }, "outputGcsDestination": { - "description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.", + "description": "The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty.", "type": "string" }, "status": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json index a0f3df05d72..e3853983768 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json @@ -292,7 +292,7 @@ } } }, - "revision": "20211125", + "revision": "20211214", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -840,7 +840,7 @@ "type": "string" }, "outputGcsDestination": { - "description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.", + "description": "The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty.", "type": "string" }, "status": { @@ -1173,7 +1173,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta1DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1beta1DocumentEntity", "properties": { "confidence": { @@ -1262,7 +1262,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -1858,11 +1858,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -1872,7 +1872,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", "properties": { "id": { @@ -1881,12 +1881,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -1922,6 +1922,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -2359,7 +2366,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta2DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1beta2DocumentEntity", "properties": { "confidence": { @@ -2448,7 +2455,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -3064,11 +3071,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -3078,7 +3085,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", "properties": { "id": { @@ -3087,12 +3094,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -3128,6 +3135,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -3652,7 +3666,7 @@ "type": "string" }, "outputGcsDestination": { - "description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.", + "description": "The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty.", "type": "string" }, "status": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index ed48126b29a..ee27f98bd0e 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -119,7 +119,7 @@ ], "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}", + "description": "Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -309,7 +309,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", "required": true, @@ -337,7 +337,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}", + "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, @@ -482,7 +482,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}", + "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, @@ -507,7 +507,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", "required": true, @@ -599,7 +599,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$", "required": true, @@ -716,7 +716,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}", + "description": "Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", "required": true, @@ -741,7 +741,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}", + "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$", "required": true, @@ -796,7 +796,7 @@ } } }, - "revision": "20211125", + "revision": "20211214", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1344,7 +1344,7 @@ "type": "string" }, "outputGcsDestination": { - "description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.", + "description": "The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty.", "type": "string" }, "status": { @@ -1677,7 +1677,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta1DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1beta1DocumentEntity", "properties": { "confidence": { @@ -1766,7 +1766,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -2362,11 +2362,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -2376,7 +2376,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", "properties": { "id": { @@ -2385,12 +2385,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -2426,6 +2426,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -2838,7 +2845,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta2DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1beta2DocumentEntity", "properties": { "confidence": { @@ -2927,7 +2934,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -3543,11 +3550,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -3557,7 +3564,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", "properties": { "id": { @@ -3566,12 +3573,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -3607,6 +3614,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -3989,7 +4003,7 @@ "type": "string" }, "outputGcsDestination": { - "description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.", + "description": "The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty.", "type": "string" }, "status": { @@ -4270,7 +4284,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1beta3DocumentEntity", "properties": { "confidence": { @@ -4359,7 +4373,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective 'structured_value' fields may also be populated. Also not all the types of 'structured_value' will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -4977,11 +4991,11 @@ "EVAL_SKIPPED" ], "enumDescriptions": [ - "Operation type unspecified.", - "Add an element. Implicit if no `parents` are set for the provenance.", - "The element is removed. No `parents` should be set.", - "Explicitly replaces the element(s) identified by `parents`.", - "Element is requested for human review.", + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Replace an element identified by `parent`.", + "Request human review for the element identified by `parent`.", "Element is reviewed and approved at human review, confidence will be set to 1.0.", "Element is skipped in the validation process." ], @@ -4991,7 +5005,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DocumentProvenanceParent": { - "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", "id": "GoogleCloudDocumentaiV1beta3DocumentProvenanceParent", "properties": { "id": { @@ -5000,12 +5014,12 @@ "type": "integer" }, "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) on parent revision.", + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", "format": "int32", "type": "integer" }, "revision": { - "description": "The index of the [Document.revisions] identifying the parent revision.", + "description": "The index of the index into current revision's parent_ids list.", "format": "int32", "type": "integer" } @@ -5041,6 +5055,13 @@ }, "type": "array" }, + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, "processor": { "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" @@ -5399,7 +5420,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3Processor": { - "description": "The first-class citizen for DAI. Each processor defines how to extract structural information from a document.", + "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", "id": "GoogleCloudDocumentaiV1beta3Processor", "properties": { "createTime": { @@ -5420,7 +5441,7 @@ "type": "string" }, "name": { - "description": "Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}", + "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", "readOnly": true, "type": "string" }, @@ -5443,7 +5464,7 @@ ], "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 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.", @@ -5462,11 +5483,11 @@ "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: 9.", + "description": "A processor type is responsible for performing a certain document understanding task on a certain type of document.", "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 request access.", + "description": "Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.", "type": "boolean" }, "availableLocations": { @@ -5540,7 +5561,7 @@ "type": "string" }, "name": { - "description": "The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}", + "description": "The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", "type": "string" }, "state": { @@ -5632,7 +5653,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ReviewDocumentRequest": { - "description": "Request message for review document method. Next Id: 6.", + "description": "Request message for review document method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentRequest", "properties": { "document": { diff --git a/googleapiclient/discovery_cache/documents/domains.v1.json b/googleapiclient/discovery_cache/documents/domains.v1.json index 79d977d20c7..7cb0f10ac12 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1.json +++ b/googleapiclient/discovery_cache/documents/domains.v1.json @@ -779,7 +779,7 @@ } } }, - "revision": "20211115", + "revision": "20211210", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json index 83a25ecc05c..bb2e47e1afd 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json @@ -779,7 +779,7 @@ } } }, - "revision": "20211115", + "revision": "20211210", "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 71426799c5d..196fc95672b 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/domains.v1beta1.json @@ -779,7 +779,7 @@ } } }, - "revision": "20211115", + "revision": "20211210", "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 206305f1d30..646b4bdfbfe 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 3702ddb2ea7..ecf691736b2 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/DKlnCJrAPG7Z0EmxOda3T9GAzb4\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/zekGFAotWiyqWap1z25R6ZBrWoo\"", "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" @@ -1659,7 +1659,7 @@ ] }, "patch": { - "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might might change automatically, such as modifiedDate. This method supports patch semantics.", + "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", "httpMethod": "PATCH", "id": "drive.files.patch", "parameterOrder": [ @@ -3527,7 +3527,7 @@ } } }, - "revision": "20211128", + "revision": "20211213", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 683bb16e73f..2ea54a3ac10 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/qPmrOOB23uwdXjGLvxs8tae5rOM\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/HNed2DTOJHwowccis8XgEVSbJXo\"", "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" @@ -2191,7 +2191,7 @@ } } }, - "revision": "20211128", + "revision": "20211213", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index fcda091d0c8..4af90a63762 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, - "revision": "20211130", + "revision": "20211222", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index 5cdd06886de..0b13d1a9edb 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json index 8fcd80d3322..881a02e8514 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json @@ -675,7 +675,7 @@ } } }, - "revision": "20211105", + "revision": "20211130", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { @@ -773,7 +773,7 @@ "properties": { "cloudRun": { "$ref": "CloudRun", - "description": "Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger." + "description": "Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger." }, "gke": { "$ref": "GKE", diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json b/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json index c72adcd4c17..b60f7eb24d4 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json @@ -584,7 +584,7 @@ } } }, - "revision": "20211105", + "revision": "20211130", "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 7cadb89de41..27a0c823a26 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -304,7 +304,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 b8cf0f64c3a..8f6c1b4ab93 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20211115", + "revision": "20211213", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index 3dc16198ca5..f5602748b58 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json index ea407904ba1..e9efe536d25 100644 --- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json @@ -1121,7 +1121,7 @@ } } }, - "revision": "20211203", + "revision": "20211230", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 61a5de496f5..865a1f13f2a 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -1183,7 +1183,7 @@ } } }, - "revision": "20211203", + "revision": "20211214", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse": { diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index ea4a74cef13..149d95da225 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -317,7 +317,7 @@ } } }, - "revision": "20211203", + "revision": "20211230", "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 fdf26f81843..e5a9cf6d76b 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, - "revision": "20211129", + "revision": "20220103", "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 1fb9a790ad3..90f6a6840b1 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -186,7 +186,7 @@ } } }, - "revision": "20211130", + "revision": "20211203", "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 e40e45b8edc..42a83a0b044 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -1939,7 +1939,7 @@ } } }, - "revision": "20211130", + "revision": "20211203", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { diff --git a/googleapiclient/discovery_cache/documents/firebaserules.v1.json b/googleapiclient/discovery_cache/documents/firebaserules.v1.json index 9c1b67dc739..694af315f16 100644 --- a/googleapiclient/discovery_cache/documents/firebaserules.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaserules.v1.json @@ -477,7 +477,7 @@ } } }, - "revision": "20211027", + "revision": "20211206", "rootUrl": "https://firebaserules.googleapis.com/", "schemas": { "Arg": { diff --git a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json index a3e90905834..65b0e7e90cc 100644 --- a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json @@ -238,7 +238,7 @@ } } }, - "revision": "20211125", + "revision": "20211213", "rootUrl": "https://firebasestorage.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index f8bb2f80960..c8cdec77b56 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1247,7 +1247,7 @@ } } }, - "revision": "20211029", + "revision": "20211206", "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 358e3a11a88..043ef3fcdfe 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -849,7 +849,7 @@ } } }, - "revision": "20211029", + "revision": "20211206", "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 6d082a74657..fcc6731482a 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json @@ -415,7 +415,7 @@ } } }, - "revision": "20211029", + "revision": "20211206", "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 ac50578758b..1d072993620 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -831,7 +831,7 @@ } } }, - "revision": "20211130", + "revision": "20211214", "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 ec46766dedf..fb2df354e26 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -1224,7 +1224,7 @@ } } }, - "revision": "20211125", + "revision": "20211213", "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 a62a90840da..34e2a93aa65 100644 --- a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +++ b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json @@ -439,7 +439,7 @@ } } }, - "revision": "20211125", + "revision": "20211213", "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 65e2b2bae28..ec8596c4c90 100644 --- a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +++ b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json @@ -471,7 +471,7 @@ } } }, - "revision": "20211125", + "revision": "20211213", "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 4c212804777..3ad68e6f4e8 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1.json @@ -1357,7 +1357,7 @@ } } }, - "revision": "20211112", + "revision": "20211206", "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 7d76133be03..a444f1a0e7b 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1beta.json @@ -1357,7 +1357,7 @@ } } }, - "revision": "20211201", + "revision": "20211206", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index c8d38e722ea..aeb78e1937b 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -905,7 +905,7 @@ } } }, - "revision": "20211111", + "revision": "20211203", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2451,6 +2451,10 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sVersion": { + "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "type": "string" + }, "v1beta1Crd": { "description": "Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index b094c62fe8e..aba857ae975 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -1067,9 +1067,24 @@ } } }, - "revision": "20211111", + "revision": "20211203", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { + "AnthosObservabilityMembershipSpec": { + "description": "**Anthosobservability**: Per-Membership Feature spec.", + "id": "AnthosObservabilityMembershipSpec", + "properties": { + "doNotOptimizeMetrics": { + "description": "use full of metrics rather than optimized metrics. See https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics", + "type": "boolean" + }, + "enableStackdriverOnApplications": { + "description": "enable collecting and reporting metrics and logs from user apps See go/onyx-application-metrics-logs-user-guide", + "type": "boolean" + } + }, + "type": "object" + }, "AppDevExperienceFeatureSpec": { "description": "Spec for App Dev Experience Feature.", "id": "AppDevExperienceFeatureSpec", @@ -2663,6 +2678,10 @@ "description": "MembershipFeatureSpec contains configuration information for a single Membership.", "id": "MembershipFeatureSpec", "properties": { + "anthosobservability": { + "$ref": "AnthosObservabilityMembershipSpec", + "description": "Anthos Observability-specific spec" + }, "configmanagement": { "$ref": "ConfigManagementMembershipSpec", "description": "Config Management-specific spec." @@ -2948,6 +2967,10 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sVersion": { + "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "type": "string" + }, "v1beta1Crd": { "description": "Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json index c6b259720ab..377df7dc97f 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json @@ -652,7 +652,7 @@ } } }, - "revision": "20211111", + "revision": "20211203", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1355,6 +1355,10 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sVersion": { + "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "type": "string" + }, "v1beta1Crd": { "description": "Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index fa4bdd7884b..2e502d0a976 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -670,7 +670,7 @@ } } }, - "revision": "20211111", + "revision": "20211203", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index 7d9985c695f..e068e36a89a 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -706,7 +706,7 @@ } } }, - "revision": "20211111", + "revision": "20211203", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1411,6 +1411,10 @@ "description": "Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.", "type": "string" }, + "k8sVersion": { + "description": "Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.", + "type": "string" + }, "v1beta1Crd": { "description": "Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index a30bd61f9b6..0313fa16a8d 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -2682,7 +2682,7 @@ } } }, - "revision": "20211129", + "revision": "20211218", "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 5943061cf6e..61d103d9b16 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 17e94d97580..9f7949fe1ce 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 6575ab7cf31..08b6567079d 100644 --- a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20211117", + "revision": "20211209", "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 1d275bc4e44..374aee7e6ed 100644 --- a/googleapiclient/discovery_cache/documents/groupssettings.v1.json +++ b/googleapiclient/discovery_cache/documents/groupssettings.v1.json @@ -152,7 +152,7 @@ } } }, - "revision": "20211111", + "revision": "20211209", "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 d12fd280da1..838cc1f580e 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -300,7 +300,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -600,7 +600,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -1712,7 +1712,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -2734,7 +2734,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -2999,6 +2999,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "Resource-validate": { + "description": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate", + "parameterOrder": [ + "parent", + "type" + ], + "parameters": { + "parent": { + "description": "The name of the FHIR store that holds the profiles being used for validation.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", + "required": true, + "type": "string" + }, + "profile": { + "description": "A profile that this resource should be validated against.", + "location": "query", + "type": "string" + }, + "type": { + "description": "The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/fhir/{+type}/$validate", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "capabilities": { "description": "Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", @@ -3455,7 +3496,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -4012,7 +4053,7 @@ } } }, - "revision": "20211118", + "revision": "20220104", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5109,7 +5150,7 @@ "type": "string" }, "paths": { - "description": "List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For \"choice\" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, \"deceasedAge.unit\" is matched by \"Deceased.Age.unit\". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Base64Binary is also supported, but may only be kept as-is or have all the content removed.", + "description": "List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For \"choice\" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, \"deceasedAge.unit\" is matched by \"Deceased.Age.unit\". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml.", "items": { "type": "string" }, @@ -6066,7 +6107,7 @@ "type": "string" }, "version": { - "description": "Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation.", + "description": "Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation.", "enum": [ "PARSER_VERSION_UNSPECIFIED", "V1", @@ -6677,6 +6718,10 @@ "description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, + "disableProfileValidation": { + "description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", + "type": "boolean" + }, "disableReferenceTypeValidation": { "description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" @@ -6684,6 +6729,13 @@ "disableRequiredFieldValidation": { "description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" + }, + "enabledImplementationGuides": { + "description": "A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index b80fde6d823..4d2946e5745 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -300,7 +300,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -600,7 +600,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -1107,7 +1107,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -2219,7 +2219,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -3269,7 +3269,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -4256,7 +4256,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -4865,7 +4865,7 @@ } } }, - "revision": "20211118", + "revision": "20220104", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5503,7 +5503,7 @@ "id": "CryptoHashConfig", "properties": { "cryptoKey": { - "description": "An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified.", + "description": "An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set.", "format": "byte", "type": "string" } @@ -5530,7 +5530,7 @@ "id": "DateShiftConfig", "properties": { "cryptoKey": { - "description": "An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified.", + "description": "An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each de-identification operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set.", "format": "byte", "type": "string" } @@ -6194,7 +6194,7 @@ "type": "string" }, "paths": { - "description": "List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field \"Patient.Address.city\", which uses a string type, can be matched by \"Patient.Address.String\". Path also supports partial matching. For example, \"Patient.Address.city\" can be matched by \"Address.city\" (Patient omitted). Partial matching and type matching can be combined. For example, \"Patient.Address.city\" can be matched by \"Address.String\". For \"choice\" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, \"deceasedAge.unit\" is matched by \"Deceased.Age.unit\". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. The sub-type for HumanName, such as HumanName.given or HumanName.family, can be omitted.", + "description": "List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field \"Patient.Address.city\", which uses a string type, can be matched by \"Patient.Address.String\". Path also supports partial matching. For example, \"Patient.Address.city\" can be matched by \"Address.city\" (Patient omitted). Partial matching and type matching can be combined. For example, \"Patient.Address.city\" can be matched by \"Address.String\". For \"choice\" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, \"deceasedAge.unit\" is matched by \"Deceased.Age.unit\". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted.", "items": { "type": "string" }, @@ -7367,7 +7367,7 @@ "type": "string" }, "version": { - "description": "Immutable. Determines the version of the unschematized parser to be used when `schema` is not given. This field is immutable after store creation.", + "description": "Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation.", "enum": [ "PARSER_VERSION_UNSPECIFIED", "V1", diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index 59444e02b03..af353d0efba 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20211201", + "revision": "20211210", "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 b4d7afc5f42..b751c5f82e4 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -1822,7 +1822,7 @@ } } }, - "revision": "20211104", + "revision": "20211202", "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 d456f1a5dc0..0c82b86a100 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -226,14 +226,14 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { "id": "GenerateAccessTokenRequest", "properties": { "delegates": { - "description": "The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.", + "description": "The sequence of service accounts in a delegation chain. This field is required for [delegated requests](https://cloud.google.com/iam/help/credentials/delegated-request). For [direct requests](https://cloud.google.com/iam/help/credentials/direct-request), which are more common, do not specify this field. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json index a37bd6c8451..d6ce16a80cc 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1.json @@ -487,7 +487,7 @@ } } }, - "revision": "20211112", + "revision": "20211210", "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 dfa73bc2453..3ace50234e4 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1beta1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20211112", + "revision": "20211210", "rootUrl": "https://iap.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json b/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json index a47a9832f4b..8788dafd07e 100644 --- a/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json @@ -331,7 +331,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://ideahub.googleapis.com/", "schemas": { "GoogleSearchIdeahubV1alphaAvailableLocale": { diff --git a/googleapiclient/discovery_cache/documents/ideahub.v1beta.json b/googleapiclient/discovery_cache/documents/ideahub.v1beta.json index 925c50398f3..3e4d957e792 100644 --- a/googleapiclient/discovery_cache/documents/ideahub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ideahub.v1beta.json @@ -288,7 +288,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://ideahub.googleapis.com/", "schemas": { "GoogleSearchIdeahubV1betaAvailableLocale": { diff --git a/googleapiclient/discovery_cache/documents/indexing.v3.json b/googleapiclient/discovery_cache/documents/indexing.v3.json index caa4826b118..7970d6b337c 100644 --- a/googleapiclient/discovery_cache/documents/indexing.v3.json +++ b/googleapiclient/discovery_cache/documents/indexing.v3.json @@ -149,7 +149,7 @@ } } }, - "revision": "20211123", + "revision": "20211228", "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 18313d06b03..3c8834d4840 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3.json @@ -651,7 +651,7 @@ } } }, - "revision": "20211202", + "revision": "20211210", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json index 0f026a22a3e..0cc673cd6ca 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json @@ -681,7 +681,7 @@ } } }, - "revision": "20211202", + "revision": "20211210", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v4.json b/googleapiclient/discovery_cache/documents/jobs.v4.json index 12bef05c5a4..e869892c1e6 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v4.json +++ b/googleapiclient/discovery_cache/documents/jobs.v4.json @@ -903,7 +903,7 @@ } } }, - "revision": "20211202", + "revision": "20211210", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/keep.v1.json b/googleapiclient/discovery_cache/documents/keep.v1.json index 19a856673ca..89a3c13e9eb 100644 --- a/googleapiclient/discovery_cache/documents/keep.v1.json +++ b/googleapiclient/discovery_cache/documents/keep.v1.json @@ -314,7 +314,7 @@ } } }, - "revision": "20211130", + "revision": "20211214", "rootUrl": "https://keep.googleapis.com/", "schemas": { "Attachment": { diff --git a/googleapiclient/discovery_cache/documents/kgsearch.v1.json b/googleapiclient/discovery_cache/documents/kgsearch.v1.json index 78333b8faf5..ad767910136 100644 --- a/googleapiclient/discovery_cache/documents/kgsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/kgsearch.v1.json @@ -151,7 +151,7 @@ } } }, - "revision": "20211112", + "revision": "20220103", "rootUrl": "https://kgsearch.googleapis.com/", "schemas": { "SearchResponse": { diff --git a/googleapiclient/discovery_cache/documents/language.v1.json b/googleapiclient/discovery_cache/documents/language.v1.json index 22a2f706094..8b282a5f1de 100644 --- a/googleapiclient/discovery_cache/documents/language.v1.json +++ b/googleapiclient/discovery_cache/documents/language.v1.json @@ -227,7 +227,7 @@ } } }, - "revision": "20211203", + "revision": "20211210", "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 a6f3c202343..590932c17b0 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta1.json @@ -189,7 +189,7 @@ } } }, - "revision": "20211203", + "revision": "20211210", "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 c84464d6094..70d48e2b69f 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta2.json @@ -227,7 +227,7 @@ } } }, - "revision": "20211203", + "revision": "20211210", "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 e91a820638e..1c2caca6c5e 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 781fe491ea7..f62007ee547 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20211204", + "revision": "20211220", "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 a5222ad6e4a..83ce3690754 100644 --- a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +++ b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json @@ -312,7 +312,7 @@ } } }, - "revision": "20211125", + "revision": "20211203", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index 48c37b9f172..95dc97d72dc 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 e88185c08ad..a11c99f2b03 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -120,7 +120,7 @@ "billingAccounts": { "methods": { "getCmekSettings": { - "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", + "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/billingAccounts/{billingAccountsId}/cmekSettings", "httpMethod": "GET", "id": "logging.billingAccounts.getCmekSettings", @@ -1407,7 +1407,7 @@ "folders": { "methods": { "getCmekSettings": { - "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", + "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/folders/{foldersId}/cmekSettings", "httpMethod": "GET", "id": "logging.folders.getCmekSettings", @@ -3089,7 +3089,7 @@ "organizations": { "methods": { "getCmekSettings": { - "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", + "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/organizations/{organizationsId}/cmekSettings", "httpMethod": "GET", "id": "logging.organizations.getCmekSettings", @@ -4151,7 +4151,7 @@ "projects": { "methods": { "getCmekSettings": { - "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", + "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/projects/{projectsId}/cmekSettings", "httpMethod": "GET", "id": "logging.projects.getCmekSettings", @@ -5507,7 +5507,7 @@ "v2": { "methods": { "getCmekSettings": { - "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", + "description": "Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "flatPath": "v2/{v2Id}/{v2Id1}/cmekSettings", "httpMethod": "GET", "id": "logging.getCmekSettings", @@ -5572,7 +5572,7 @@ } } }, - "revision": "20211108", + "revision": "20211130", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryOptions": { @@ -5630,7 +5630,7 @@ "type": "string" }, "serviceAccountId": { - "description": "Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", + "description": "Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index 7c29d6f196a..eea3c57a5aa 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -1170,7 +1170,7 @@ } } }, - "revision": "20211106", + "revision": "20211111", "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 68c9902a74c..903493a21e0 100644 --- a/googleapiclient/discovery_cache/documents/ml.v1.json +++ b/googleapiclient/discovery_cache/documents/ml.v1.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "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 3c522d5118d..361b5013669 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -679,7 +679,7 @@ } } }, - "revision": "20211201", + "revision": "20211213", "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 06eb944a9b4..2ac70ae8990 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2571,7 +2571,7 @@ } } }, - "revision": "20211201", + "revision": "20211213", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -3514,7 +3514,7 @@ "description": "The authentication information. Optional when creating an HTTP check; defaults to empty." }, "body": { - "description": "The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: \"foo=bar\" in URL-encoded form is \"foo%3Dbar\" and in base64 encoding is \"Zm9vJTI1M0RiYXI=\".", + "description": "The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.", "format": "byte", "type": "string" }, @@ -4975,7 +4975,7 @@ "type": "object" }, "TimeInterval": { - "description": "Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time.", + "description": "Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time.", "id": "TimeInterval", "properties": { "endTime": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index 97a44ee3eb2..d2d649e7994 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index f6288d07179..4370119d8d5 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -465,7 +465,7 @@ } }, "delete": { - "description": "Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google My Business](https://business.google.com/manage/) website.", + "description": "Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google Business Profile](https://business.google.com/manage/) website.", "flatPath": "v1/locations/{locationsId}", "httpMethod": "DELETE", "id": "mybusinessbusinessinformation.locations.delete", @@ -662,7 +662,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1163,7 +1163,7 @@ }, "latlng": { "$ref": "LatLng", - "description": "Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google My Business website. This field can only be updated by approved clients." + "description": "Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients." }, "metadata": { "$ref": "Metadata", diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index 731c2e83cce..f4c396ac0c6 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json index 68afb5100db..16aba052b95 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://mybusinessnotifications.googleapis.com/", "schemas": { "NotificationSetting": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index 4ff9017c999..eb47bf21286 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json new file mode 100644 index 00000000000..131389b1315 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json @@ -0,0 +1,519 @@ +{ + "basePath": "", + "baseUrl": "https://mybusinessqanda.googleapis.com/", + "batchPath": "batch", + "canonicalName": "My Business Q&A", + "description": "The My Business Q&A API allows questions and answers to be posted for specific listings.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/my-business/", + "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": "mybusinessqanda:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://mybusinessqanda.mtls.googleapis.com/", + "name": "mybusinessqanda", + "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": { + "locations": { + "resources": { + "questions": { + "methods": { + "create": { + "description": "Adds a question for the specified location.", + "flatPath": "v1/locations/{locationsId}/questions", + "httpMethod": "POST", + "id": "mybusinessqanda.locations.questions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the location to write a question for.", + "location": "path", + "pattern": "^locations/[^/]+/questions$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}", + "request": { + "$ref": "Question" + }, + "response": { + "$ref": "Question" + } + }, + "delete": { + "description": "Deletes a specific question written by the current user.", + "flatPath": "v1/locations/{locationsId}/questions/{questionsId}", + "httpMethod": "DELETE", + "id": "mybusinessqanda.locations.questions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the question to delete.", + "location": "path", + "pattern": "^locations/[^/]+/questions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + } + }, + "deleteAnswers": { + "description": "Deletes the answer written by the current user to a question.", + "flatPath": "v1/locations/{locationsId}/questions/{questionsId}/answers", + "httpMethod": "DELETE", + "id": "mybusinessqanda.locations.questions.deleteAnswers", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the question to delete an answer for.", + "location": "path", + "pattern": "^locations/[^/]+/questions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/answers", + "response": { + "$ref": "Empty" + } + }, + "list": { + "description": "Returns the paginated list of questions and some of its answers for a specified location. This operation is only valid if the specified location is verified.", + "flatPath": "v1/locations/{locationsId}/questions", + "httpMethod": "GET", + "id": "mybusinessqanda.locations.questions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "answersPerQuestion": { + "description": "Optional. How many answers to fetch per question. The default and maximum `answers_per_question` values are 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "filter": { + "description": "Optional. A filter constraining the questions to return. The only filter currently supported is \"ignore_answered=true\"", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The order to return the questions. Valid options include 'update_time desc' and 'upvote_count desc', which will return the questions sorted descendingly by the requested field. The default sort order is 'update_time desc'.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. How many questions to fetch per page. The default and maximum `page_size` values are 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If specified, the next page of questions is retrieved.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the location to fetch questions for.", + "location": "path", + "pattern": "^locations/[^/]+/questions$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}", + "response": { + "$ref": "ListQuestionsResponse" + } + }, + "patch": { + "description": "Updates a specific question written by the current user.", + "flatPath": "v1/locations/{locationsId}/questions/{questionsId}", + "httpMethod": "PATCH", + "id": "mybusinessqanda.locations.questions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.", + "location": "path", + "pattern": "^locations/[^/]+/questions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The specific fields to update. Only question text can be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Question" + }, + "response": { + "$ref": "Question" + } + } + }, + "resources": { + "answers": { + "methods": { + "list": { + "description": "Returns the paginated list of answers for a specified question.", + "flatPath": "v1/locations/{locationsId}/questions/{questionsId}/answers", + "httpMethod": "GET", + "id": "mybusinessqanda.locations.questions.answers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderBy": { + "description": "Optional. The order to return the answers. Valid options include 'update_time desc' and 'upvote_count desc', which will return the answers sorted descendingly by the requested field. The default sort order is 'update_time desc'.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. How many answers to fetch per page. The default and maximum `page_size` values are 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If specified, the next page of answers is retrieved.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the question to fetch answers for.", + "location": "path", + "pattern": "^locations/[^/]+/questions/[^/]+/answers$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}", + "response": { + "$ref": "ListAnswersResponse" + } + }, + "upsert": { + "description": "Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.", + "flatPath": "v1/locations/{locationsId}/questions/{questionsId}/answers:upsert", + "httpMethod": "POST", + "id": "mybusinessqanda.locations.questions.answers.upsert", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the question to write an answer for.", + "location": "path", + "pattern": "^locations/[^/]+/questions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/answers:upsert", + "request": { + "$ref": "UpsertAnswerRequest" + }, + "response": { + "$ref": "Answer" + } + } + } + } + } + } + } + } + }, + "revision": "20211211", + "rootUrl": "https://mybusinessqanda.googleapis.com/", + "schemas": { + "Answer": { + "description": "Represents an answer to a question", + "id": "Answer", + "properties": { + "author": { + "$ref": "Author", + "description": "Output only. The author of the answer. Will only be set during list operations.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The timestamp for when the answer was written. Only retrieved during ListResponse fetching.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The unique name for the answer locations/*/questions/*/answers/*", + "readOnly": true, + "type": "string" + }, + "text": { + "description": "Required. The text of the answer. It should contain at least one non-whitespace character. The maximum length is 4096 characters.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp for when the answer was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "upvoteCount": { + "description": "Output only. The number of upvotes for the answer.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "Author": { + "description": "Represents the author of a question or answer", + "id": "Author", + "properties": { + "displayName": { + "description": "The display name of the user", + "type": "string" + }, + "profilePhotoUri": { + "description": "The profile photo URI of the user.", + "type": "string" + }, + "type": { + "description": "The type of user the author is.", + "enum": [ + "AUTHOR_TYPE_UNSPECIFIED", + "REGULAR_USER", + "LOCAL_GUIDE", + "MERCHANT" + ], + "enumDescriptions": [ + "This should not be used.", + "A regular user.", + "A Local Guide", + "The owner/manager of the location" + ], + "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" + }, + "ListAnswersResponse": { + "description": "Response message for QuestionsAndAnswers.ListAnswers", + "id": "ListAnswersResponse", + "properties": { + "answers": { + "description": "The requested answers.", + "items": { + "$ref": "Answer" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If the number of answers exceeds the requested max page size, this field is populated with a token to fetch the next page of answers on a subsequent call. If there are no more answers, this field is not present in the response.", + "type": "string" + }, + "totalSize": { + "description": "The total number of answers posted for this question across all pages.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ListQuestionsResponse": { + "description": "Response message for QuestionsAndAnswers.ListQuestions", + "id": "ListQuestionsResponse", + "properties": { + "nextPageToken": { + "description": "If the number of questions exceeds the requested max page size, this field is populated with a token to fetch the next page of questions on a subsequent call. If there are no more questions, this field is not present in the response.", + "type": "string" + }, + "questions": { + "description": "The requested questions,", + "items": { + "$ref": "Question" + }, + "type": "array" + }, + "totalSize": { + "description": "The total number of questions posted for this location across all pages.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Question": { + "description": "Represents a single question and some of its answers.", + "id": "Question", + "properties": { + "author": { + "$ref": "Author", + "description": "Output only. The author of the question.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The timestamp for when the question was written.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. The unique name for the question. locations/*/questions/* This field will be ignored if set during question creation.", + "type": "string" + }, + "text": { + "description": "Required. The text of the question. It should contain at least three words and the total length should be greater than or equal to 10 characters. The maximum length is 4096 characters.", + "type": "string" + }, + "topAnswers": { + "description": "Output only. A list of answers to the question, sorted by upvotes. This may not be a complete list of answers depending on the request parameters (answers_per_question)", + "items": { + "$ref": "Answer" + }, + "readOnly": true, + "type": "array" + }, + "totalAnswerCount": { + "description": "Output only. The total number of answers posted for this question.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "updateTime": { + "description": "Output only. The timestamp for when the question was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "upvoteCount": { + "description": "Output only. The number of upvotes for the question.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "UpsertAnswerRequest": { + "description": "Request message for QuestionsAndAnswers.UpsertAnswer", + "id": "UpsertAnswerRequest", + "properties": { + "answer": { + "$ref": "Answer", + "description": "Required. The new answer." + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "My Business Q&A API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index f8e467713bd..5fd173b7ee2 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -256,7 +256,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 84ca3c33a87..957c15e45c1 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -938,7 +938,7 @@ } } }, - "revision": "20211113", + "revision": "20211210", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { @@ -1463,6 +1463,11 @@ "description": "RoutingVPC contains information about the VPC network that is associated with a hub's spokes.", "id": "RoutingVPC", "properties": { + "requiredForNewSiteToSiteDataTransferSpokes": { + "description": "Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network.", + "readOnly": true, + "type": "boolean" + }, "uri": { "description": "The URI of the VPC network.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index c26e7c6479c..372ad430373 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -938,7 +938,7 @@ } } }, - "revision": "20211113", + "revision": "20220104", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 4a5febdb0de..a4fb87a58a9 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -822,7 +822,7 @@ } } }, - "revision": "20211109", + "revision": "20211209", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 30d3d493c9c..ede2b9e1e50 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -543,13 +543,104 @@ ] } } + }, + "serviceBindings": { + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", + "httpMethod": "GET", + "id": "networkservices.projects.locations.serviceBindings.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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/[^/]+/serviceBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", + "httpMethod": "POST", + "id": "networkservices.projects.locations.serviceBindings.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/[^/]+/serviceBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", + "httpMethod": "POST", + "id": "networkservices.projects.locations.serviceBindings.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/[^/]+/serviceBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20211109", + "revision": "20211209", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index 47efb18cdc8..a074aa98b0c 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20211115", + "revision": "20211206", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -596,6 +596,158 @@ }, "type": "object" }, + "CVSS": { + "description": "Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score.", + "id": "CVSS", + "properties": { + "attackComplexity": { + "enum": [ + "ATTACK_COMPLEXITY_UNSPECIFIED", + "ATTACK_COMPLEXITY_LOW", + "ATTACK_COMPLEXITY_HIGH" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "attackVector": { + "description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.", + "enum": [ + "ATTACK_VECTOR_UNSPECIFIED", + "ATTACK_VECTOR_NETWORK", + "ATTACK_VECTOR_ADJACENT", + "ATTACK_VECTOR_LOCAL", + "ATTACK_VECTOR_PHYSICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "authentication": { + "enum": [ + "AUTHENTICATION_UNSPECIFIED", + "AUTHENTICATION_MULTIPLE", + "AUTHENTICATION_SINGLE", + "AUTHENTICATION_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "availabilityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "baseScore": { + "description": "The base score is a function of the base metric scores.", + "format": "float", + "type": "number" + }, + "confidentialityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "exploitabilityScore": { + "format": "float", + "type": "number" + }, + "impactScore": { + "format": "float", + "type": "number" + }, + "integrityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "privilegesRequired": { + "enum": [ + "PRIVILEGES_REQUIRED_UNSPECIFIED", + "PRIVILEGES_REQUIRED_NONE", + "PRIVILEGES_REQUIRED_LOW", + "PRIVILEGES_REQUIRED_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "scope": { + "enum": [ + "SCOPE_UNSPECIFIED", + "SCOPE_UNCHANGED", + "SCOPE_CHANGED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "userInteraction": { + "enum": [ + "USER_INTERACTION_UNSPECIFIED", + "USER_INTERACTION_NONE", + "USER_INTERACTION_REQUIRED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "Category": { "description": "The category to which the update belongs.", "id": "Category", @@ -1878,6 +2030,10 @@ "format": "float", "type": "number" }, + "cvssv3": { + "$ref": "CVSS", + "description": "The cvss v3 score for the vulnerability." + }, "effectiveSeverity": { "description": "The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 588a2a368b3..027d1d74b4b 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20211115", + "revision": "20211206", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -592,6 +592,158 @@ }, "type": "object" }, + "CVSS": { + "description": "Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score.", + "id": "CVSS", + "properties": { + "attackComplexity": { + "enum": [ + "ATTACK_COMPLEXITY_UNSPECIFIED", + "ATTACK_COMPLEXITY_LOW", + "ATTACK_COMPLEXITY_HIGH" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "attackVector": { + "description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.", + "enum": [ + "ATTACK_VECTOR_UNSPECIFIED", + "ATTACK_VECTOR_NETWORK", + "ATTACK_VECTOR_ADJACENT", + "ATTACK_VECTOR_LOCAL", + "ATTACK_VECTOR_PHYSICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "authentication": { + "enum": [ + "AUTHENTICATION_UNSPECIFIED", + "AUTHENTICATION_MULTIPLE", + "AUTHENTICATION_SINGLE", + "AUTHENTICATION_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "availabilityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "baseScore": { + "description": "The base score is a function of the base metric scores.", + "format": "float", + "type": "number" + }, + "confidentialityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "exploitabilityScore": { + "format": "float", + "type": "number" + }, + "impactScore": { + "format": "float", + "type": "number" + }, + "integrityImpact": { + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "privilegesRequired": { + "enum": [ + "PRIVILEGES_REQUIRED_UNSPECIFIED", + "PRIVILEGES_REQUIRED_NONE", + "PRIVILEGES_REQUIRED_LOW", + "PRIVILEGES_REQUIRED_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "scope": { + "enum": [ + "SCOPE_UNSPECIFIED", + "SCOPE_UNCHANGED", + "SCOPE_CHANGED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "userInteraction": { + "enum": [ + "USER_INTERACTION_UNSPECIFIED", + "USER_INTERACTION_NONE", + "USER_INTERACTION_REQUIRED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "Category": { "description": "The category to which the update belongs.", "id": "Category", @@ -1874,6 +2026,10 @@ "format": "float", "type": "number" }, + "cvssv3": { + "$ref": "CVSS", + "description": "The cvss v3 score for the vulnerability." + }, "effectiveSeverity": { "description": "The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index 08e3a4692f5..6b9aee855ae 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -783,7 +783,7 @@ } } }, - "revision": "20211203", + "revision": "20211216", "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 181aea6c03b..9b99b9ffb08 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -765,6 +765,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "pause": { + "description": "Change state of patch deployment to \"PAUSED\". Patch deployment in paused state doesn't generate patch jobs.", + "flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:pause", + "httpMethod": "POST", + "id": "osconfig.projects.patchDeployments.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.", + "location": "path", + "pattern": "^projects/[^/]+/patchDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:pause", + "request": { + "$ref": "PausePatchDeploymentRequest" + }, + "response": { + "$ref": "PatchDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Change state of patch deployment back to \"ACTIVE\". Patch deployment in active state continues to generate patch jobs.", + "flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:resume", + "httpMethod": "POST", + "id": "osconfig.projects.patchDeployments.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.", + "location": "path", + "pattern": "^projects/[^/]+/patchDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", + "request": { + "$ref": "ResumePatchDeploymentRequest" + }, + "response": { + "$ref": "PatchDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -944,7 +1000,7 @@ } } }, - "revision": "20211106", + "revision": "20211203", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -2885,6 +2941,21 @@ "$ref": "PatchRollout", "description": "Optional. Rollout strategy of the patch job." }, + "state": { + "description": "Output only. Current state of the patch deployment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "PAUSED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Active value means that patch deployment generates Patch Jobs.", + "Paused value means that patch deployment does not generate Patch jobs. Requires user action to move in and out from this state." + ], + "readOnly": true, + "type": "string" + }, "updateTime": { "description": "Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "format": "google-datetime", @@ -3210,6 +3281,12 @@ }, "type": "object" }, + "PausePatchDeploymentRequest": { + "description": "A request message for pausing a patch deployment.", + "id": "PausePatchDeploymentRequest", + "properties": {}, + "type": "object" + }, "RecurringSchedule": { "description": "Sets the time for recurring patch deployments.", "id": "RecurringSchedule", @@ -3271,6 +3348,12 @@ }, "type": "object" }, + "ResumePatchDeploymentRequest": { + "description": "A request message for resuming a patch deployment.", + "id": "ResumePatchDeploymentRequest", + "properties": {}, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index a787c07b8af..70a5ed1e7a1 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -684,7 +684,7 @@ } } }, - "revision": "20211106", + "revision": "20211203", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index 39f75bd53db..cc20697260d 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -418,6 +418,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "pause": { + "description": "Change state of patch deployment to \"PAUSED\". Patch deployment in paused state doesn't generate patch jobs.", + "flatPath": "v1beta/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:pause", + "httpMethod": "POST", + "id": "osconfig.projects.patchDeployments.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.", + "location": "path", + "pattern": "^projects/[^/]+/patchDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:pause", + "request": { + "$ref": "PausePatchDeploymentRequest" + }, + "response": { + "$ref": "PatchDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Change state of patch deployment back to \"ACTIVE\". Patch deployment in active state continues to generate patch jobs.", + "flatPath": "v1beta/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:resume", + "httpMethod": "POST", + "id": "osconfig.projects.patchDeployments.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.", + "location": "path", + "pattern": "^projects/[^/]+/patchDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:resume", + "request": { + "$ref": "ResumePatchDeploymentRequest" + }, + "response": { + "$ref": "PatchDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -633,7 +689,7 @@ } } }, - "revision": "20211106", + "revision": "20211203", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -1472,6 +1528,21 @@ "$ref": "PatchRollout", "description": "Optional. Rollout strategy of the patch job." }, + "state": { + "description": "Output only. Current state of the patch deployment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "PAUSED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Active value means that patch deployment generates Patch Jobs.", + "Paused value means that patch deployment does not generate Patch jobs. Requires user action to move in and out from this state." + ], + "readOnly": true, + "type": "string" + }, "updateTime": { "description": "Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "format": "google-datetime", @@ -1797,6 +1868,12 @@ }, "type": "object" }, + "PausePatchDeploymentRequest": { + "description": "A request message for pausing a patch deployment.", + "id": "PausePatchDeploymentRequest", + "properties": {}, + "type": "object" + }, "RecurringSchedule": { "description": "Sets the time for recurring patch deployments.", "id": "RecurringSchedule", @@ -1858,6 +1935,12 @@ }, "type": "object" }, + "ResumePatchDeploymentRequest": { + "description": "A request message for resuming a patch deployment.", + "id": "ResumePatchDeploymentRequest", + "properties": {}, + "type": "object" + }, "SoftwareRecipe": { "description": "A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step.", "id": "SoftwareRecipe", diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1.json b/googleapiclient/discovery_cache/documents/oslogin.v1.json index 12cd6c064bc..464e34e51e9 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1.json @@ -220,13 +220,13 @@ } } }, - "sshPublicKey": { + "sshPublicKeys": { "methods": { "create": { "description": "Create an SSH public key", - "flatPath": "v1/users/{usersId}/sshPublicKey", + "flatPath": "v1/users/{usersId}/sshPublicKeys", "httpMethod": "POST", - "id": "oslogin.users.sshPublicKey.create", + "id": "oslogin.users.sshPublicKeys.create", "parameterOrder": [ "parent" ], @@ -239,7 +239,7 @@ "type": "string" } }, - "path": "v1/{+parent}/sshPublicKey", + "path": "v1/{+parent}/sshPublicKeys", "request": { "$ref": "SshPublicKey" }, @@ -250,11 +250,7 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "sshPublicKeys": { - "methods": { + }, "delete": { "description": "Deletes an SSH public key.", "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", @@ -347,7 +343,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "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 022219aa092..b71ea8b4b93 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json @@ -280,13 +280,13 @@ } } }, - "sshPublicKey": { + "sshPublicKeys": { "methods": { "create": { "description": "Create an SSH public key", - "flatPath": "v1alpha/users/{usersId}/sshPublicKey", + "flatPath": "v1alpha/users/{usersId}/sshPublicKeys", "httpMethod": "POST", - "id": "oslogin.users.sshPublicKey.create", + "id": "oslogin.users.sshPublicKeys.create", "parameterOrder": [ "parent" ], @@ -299,7 +299,7 @@ "type": "string" } }, - "path": "v1alpha/{+parent}/sshPublicKey", + "path": "v1alpha/{+parent}/sshPublicKeys", "request": { "$ref": "SshPublicKey" }, @@ -310,11 +310,7 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "sshPublicKeys": { - "methods": { + }, "delete": { "description": "Deletes an SSH public key.", "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", @@ -407,7 +403,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "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 beec91689f8..e45ae1af91a 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1beta.json @@ -250,13 +250,13 @@ } } }, - "sshPublicKey": { + "sshPublicKeys": { "methods": { "create": { "description": "Create an SSH public key", - "flatPath": "v1beta/users/{usersId}/sshPublicKey", + "flatPath": "v1beta/users/{usersId}/sshPublicKeys", "httpMethod": "POST", - "id": "oslogin.users.sshPublicKey.create", + "id": "oslogin.users.sshPublicKeys.create", "parameterOrder": [ "parent" ], @@ -269,7 +269,7 @@ "type": "string" } }, - "path": "v1beta/{+parent}/sshPublicKey", + "path": "v1beta/{+parent}/sshPublicKeys", "request": { "$ref": "SshPublicKey" }, @@ -280,11 +280,7 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] - } - } - }, - "sshPublicKeys": { - "methods": { + }, "delete": { "description": "Deletes an SSH public key.", "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", @@ -377,7 +373,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "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 8d44ad71a57..a227fa3bb16 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -193,7 +193,7 @@ } } }, - "revision": "20211130", + "revision": "20211230", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 8d0c3db729e..c42b7199266 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -366,7 +366,7 @@ } } }, - "revision": "20211206", + "revision": "20211214", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest": { diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index b5794d85235..4412a29440e 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -1172,7 +1172,7 @@ } } }, - "revision": "20211202", + "revision": "20211215", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index 48cce100beb..77e6384a480 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, - "revision": "20211203", + "revision": "20211214", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json index b09af31146c..9f7489a649f 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json index cad3a900b8e..dc8e41daa92 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1beta1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index c04fc7d94e9..d59096e815f 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -493,7 +493,7 @@ } } }, - "revision": "20211112", + "revision": "20211211", "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 c98dc2f9396..0539b0654f4 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json @@ -493,7 +493,7 @@ } } }, - "revision": "20211112", + "revision": "20211211", "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 1dca19f1f70..68bd8d9178e 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "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 b0c678c0048..4eb6c12659c 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json @@ -128,7 +128,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1betaAccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json index e3216a96f91..c804b1cda03 100644 --- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json @@ -2527,7 +2527,7 @@ } } }, - "revision": "20211203", + "revision": "20211215", "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 86d2e38c9f9..c13d6ab358c 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1424,7 +1424,7 @@ } } }, - "revision": "20211108", + "revision": "20211130", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -2045,7 +2045,7 @@ }, "pushConfig": { "$ref": "PushConfig", - "description": "If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods." + "description": "If push delivery is used with this subscription, this field is used to configure it. At most one of `pushConfig` and `bigQueryConfig` can be set. If both are empty, then the subscriber will pull and ack messages using API methods." }, "retainAckedMessages": { "description": "Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.", @@ -2055,6 +2055,21 @@ "$ref": "RetryPolicy", "description": "A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." }, + "state": { + "description": "Output only. An output-only field indicating whether or not the subscription can receive messages.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "RESOURCE_ERROR" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The subscription can actively receive messages", + "The subscription cannot receive messages because of an error with the resource to which it pushes messages. See the more detailed error state in the corresponding configuration." + ], + "readOnly": true, + "type": "string" + }, "topic": { "description": "Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json index b95bda8e237..f0835993976 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json @@ -457,7 +457,7 @@ } } }, - "revision": "20211108", + "revision": "20211130", "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 375fe9bb410..1b5c705c714 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json @@ -724,7 +724,7 @@ } } }, - "revision": "20211108", + "revision": "20211130", "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 b635855aea5..02474c914a7 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -1040,7 +1040,7 @@ } } }, - "revision": "20211130", + "revision": "20211210", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 9c733d7eae7..d349779b0d6 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1174,7 +1174,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "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 c3109ba89be..85564cd7ad0 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json @@ -234,7 +234,7 @@ } } }, - "revision": "20211203", + "revision": "20220104", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivateBiddingFunctionRequest": { diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index d94144d8ae7..45b4d774548 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -380,10 +380,10 @@ "httpMethod": "POST", "id": "recaptchaenterprise.projects.relatedaccountgroupmemberships.search", "parameterOrder": [ - "parent" + "project" ], "parameters": { - "parent": { + "project": { "description": "Required. The name of the project to search related account group memberships from, in the format \"projects/{project}\".", "location": "path", "pattern": "^projects/[^/]+$", @@ -391,7 +391,7 @@ "type": "string" } }, - "path": "v1/{+parent}/relatedaccountgroupmemberships:search", + "path": "v1/{+project}/relatedaccountgroupmemberships:search", "request": { "$ref": "GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest" }, @@ -489,7 +489,7 @@ } } }, - "revision": "20211112", + "revision": "20211211", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -516,6 +516,20 @@ "type": "string" }, "type": "array" + }, + "recommendedAction": { + "description": "Recommended action after this request.", + "enum": [ + "RECOMMENDED_ACTION_UNSPECIFIED", + "REQUEST_2FA", + "SKIP_2FA" + ], + "enumDescriptions": [ + "Default unspecified type.", + "The customer should probably request 2FA to their user.", + "This is likely an already seen and safe request. 2FA can be skipped." + ], + "type": "string" } }, "type": "object" @@ -571,6 +585,8 @@ "enum": [ "REASON_UNSPECIFIED", "CHARGEBACK", + "CHARGEBACK_FRAUD", + "CHARGEBACK_DISPUTE", "PAYMENT_HEURISTICS", "INITIATED_TWO_FACTOR", "PASSED_TWO_FACTOR", @@ -580,7 +596,9 @@ ], "enumDescriptions": [ "Default unspecified reason.", - "Indicates a chargeback for fraud was issued for the transaction associated with the assessment.", + "Indicates a chargeback issued for the transaction with no other details. When possible, specify the type by using CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead.", + "Indicates a chargeback related to an alleged unauthorized transaction from the cardholder's perspective (for example, the card number was stolen).", + "Indicates a chargeback related to the cardholder having provided their card details but allegedly not being satisfied with the purchase (for example, misrepresentation, attempted cancellation).", "Indicates the transaction associated with the assessment is suspected of being fraudulent based on the payment method, billing details, shipping address or other transaction information.", "Indicates that the user was served a 2FA challenge. An old assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow. This is equivalent to `FAILED_TWO_FACTOR`.", "Indicates that the user passed a 2FA challenge.", @@ -738,6 +756,10 @@ "$ref": "GoogleCloudRecaptchaenterpriseV1TestingOptions", "description": "Options for user acceptance testing." }, + "wafSettings": { + "$ref": "GoogleCloudRecaptchaenterpriseV1WafSettings", + "description": "Settings for WAF" + }, "webSettings": { "$ref": "GoogleCloudRecaptchaenterpriseV1WebKeySettings", "description": "Settings for keys that can be used by websites." @@ -1041,6 +1063,41 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1WafSettings": { + "description": "Settings specific to keys that can be used for WAF (Web Application Firewall).", + "id": "GoogleCloudRecaptchaenterpriseV1WafSettings", + "properties": { + "wafFeature": { + "description": "Required. The WAF feature for which this key is enabled.", + "enum": [ + "WAF_FEATURE_UNSPECIFIED", + "CHALLENGE_PAGE", + "SESSION_TOKEN", + "ACTION_TOKEN" + ], + "enumDescriptions": [ + "Undefined feature.", + "Redirects suspicious traffic to reCAPTCHA.", + "Use reCAPTCHA session-tokens to protect the whole user session on the site's domain.", + "Use reCAPTCHA action-tokens to protect user actions." + ], + "type": "string" + }, + "wafService": { + "description": "Required. The WAF service that uses this key.", + "enum": [ + "WAF_SERVICE_UNSPECIFIED", + "CA" + ], + "enumDescriptions": [ + "Undefined WAF", + "Cloud Armor" + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1WebKeySettings": { "description": "Settings specific to keys that can be used by websites.", "id": "GoogleCloudRecaptchaenterpriseV1WebKeySettings", diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index 77f8fcfb0cf..7c06e04c72b 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -301,7 +301,7 @@ ], "parameters": { "filter": { - "description": "Optional. A filter to apply on the list results.", + "description": "Optional. Use of this field is not supported by version v1beta1.", "location": "query", "type": "string" }, @@ -842,7 +842,7 @@ } } }, - "revision": "20211111", + "revision": "20211211", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index c25fcd8dbd3..12f5c9310ae 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -1178,7 +1178,7 @@ } } }, - "revision": "20211115", + "revision": "20211213", "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 01441fa4618..f474ded93a5 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -696,7 +696,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`", + "description": "Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "required": true, @@ -864,7 +864,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[RECOMMENDER_ID]/config`", + "description": "Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "required": true, @@ -1057,7 +1057,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`", + "description": "Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "required": true, @@ -1225,7 +1225,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[RECOMMENDER_ID]/config`", + "description": "Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "required": true, @@ -1442,7 +1442,7 @@ } } }, - "revision": "20211115", + "revision": "20211213", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1beta1CostProjection": { @@ -1472,14 +1472,16 @@ "COST", "SECURITY", "PERFORMANCE", - "MANAGEABILITY" + "MANAGEABILITY", + "SUSTAINABILITY" ], "enumDescriptions": [ "Default unspecified category. Don't use directly.", "Indicates a potential increase or decrease in cost.", "Indicates a potential increase or decrease in security.", "Indicates a potential increase or decrease in performance.", - "Indicates a potential increase or decrease in manageability." + "Indicates a potential increase or decrease in manageability.", + "Indicates a potential increase or decrease in sustainability." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 62c89f7c684..636e8aea6a8 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -624,15 +624,150 @@ } } }, - "revision": "20211109", + "revision": "20211202", "rootUrl": "https://redis.googleapis.com/", "schemas": { + "Cluster": { + "description": "A cluster instance.", + "id": "Cluster", + "properties": { + "clusterUid": { + "description": "Output only. UID of the cluster for use by Pantheon for analytics.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp associated with the cluster creation request.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customerManagedKey": { + "description": "Input only. The KMS key reference that the customer provides when trying to create the instance.", + "type": "string" + }, + "defaultReplicaCount": { + "description": "Optional. The number of replica nodes per shard. Valid range is [1-2] and defaults to 1.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "description": "Optional. An arbitrary and optional user-provided name for the cluster.", + "type": "string" + }, + "endpoints": { + "description": "Output only. Hostname or IP address and port pairs used to connect to the cluster.", + "items": { + "$ref": "Endpoint" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", + "type": "string" + }, + "privateServiceConnect": { + "$ref": "PrivateServiceConnect", + "description": "Optional. Populate to use private service connect network option." + }, + "redisConfigs": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 6.x and newer: * lfu-decay-time * lfu-log-factor * maxmemory-policy", + "type": "object" + }, + "slots": { + "description": "Output only. The slots making up the cluster. Read-only. In future versions this will be writable to allow for heterogeneous clusters.", + "items": { + "$ref": "ClusterSlots" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING" + ], + "enumDescriptions": [ + "Not set.", + "Redis cluster is being created.", + "Redis cluster has been created and is fully usable.", + "Redis cluster configuration is being updated.", + "Redis cluster is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "totalMemorySizeGb": { + "description": "Optional. Redis memory size in GiB for the entire cluster. Defaults to 32.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ClusterSlots": { + "description": "A series of slots belonging to a cluster.", + "id": "ClusterSlots", + "properties": { + "endSlotsExclusive": { + "description": "Output only. The end of the slots that make up this series.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "memorySizeGb": { + "description": "Output only. The total size of keyspace this series has.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "replicaCount": { + "description": "Output only. The number of replicas this series has.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "startSlotsInclusive": { + "description": "Output only. The start of the slots that make up this series.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "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" }, + "Endpoint": { + "description": "An endpoint exposed by a cluster. In the future we will add an enum to identify whether this endpoint is read/write or read-only when the feature is ready.", + "id": "Endpoint", + "properties": { + "host": { + "description": "Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.", + "readOnly": true, + "type": "string" + }, + "port": { + "description": "Output only. The port number of the exposed Redis endpoint.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "ExportInstanceRequest": { "description": "Request for Export.", "id": "ExportInstanceRequest", @@ -1263,6 +1398,22 @@ }, "type": "object" }, + "PrivateServiceConnect": { + "description": "Contains private service connect specific options.", + "id": "PrivateServiceConnect", + "properties": { + "pscService": { + "description": "Output only. The address of the Private Service Connect (PSC) service that the customer can use to connect this instance to their local network.", + "readOnly": true, + "type": "string" + }, + "pscServiceRoute": { + "description": "Optional. The service route to connect using Private Service Connect. On Instance creation, this will automatically connect this route to this instance.", + "type": "string" + } + }, + "type": "object" + }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index f748ea01b48..b69bb70c854 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -624,15 +624,150 @@ } } }, - "revision": "20211109", + "revision": "20211202", "rootUrl": "https://redis.googleapis.com/", "schemas": { + "Cluster": { + "description": "A cluster instance.", + "id": "Cluster", + "properties": { + "clusterUid": { + "description": "Output only. UID of the cluster for use by Pantheon for analytics.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp associated with the cluster creation request.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customerManagedKey": { + "description": "Input only. The KMS key reference that the customer provides when trying to create the instance.", + "type": "string" + }, + "defaultReplicaCount": { + "description": "Optional. The number of replica nodes per shard. Valid range is [1-2] and defaults to 1.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "description": "Optional. An arbitrary and optional user-provided name for the cluster.", + "type": "string" + }, + "endpoints": { + "description": "Output only. Hostname or IP address and port pairs used to connect to the cluster.", + "items": { + "$ref": "Endpoint" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", + "type": "string" + }, + "privateServiceConnect": { + "$ref": "PrivateServiceConnect", + "description": "Optional. Populate to use private service connect network option." + }, + "redisConfigs": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 6.x and newer: * lfu-decay-time * lfu-log-factor * maxmemory-policy", + "type": "object" + }, + "slots": { + "description": "Output only. The slots making up the cluster. Read-only. In future versions this will be writable to allow for heterogeneous clusters.", + "items": { + "$ref": "ClusterSlots" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING" + ], + "enumDescriptions": [ + "Not set.", + "Redis cluster is being created.", + "Redis cluster has been created and is fully usable.", + "Redis cluster configuration is being updated.", + "Redis cluster is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "totalMemorySizeGb": { + "description": "Optional. Redis memory size in GiB for the entire cluster. Defaults to 32.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ClusterSlots": { + "description": "A series of slots belonging to a cluster.", + "id": "ClusterSlots", + "properties": { + "endSlotsExclusive": { + "description": "Output only. The end of the slots that make up this series.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "memorySizeGb": { + "description": "Output only. The total size of keyspace this series has.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "replicaCount": { + "description": "Output only. The number of replicas this series has.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "startSlotsInclusive": { + "description": "Output only. The start of the slots that make up this series.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "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" }, + "Endpoint": { + "description": "An endpoint exposed by a cluster. In the future we will add an enum to identify whether this endpoint is read/write or read-only when the feature is ready.", + "id": "Endpoint", + "properties": { + "host": { + "description": "Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.", + "readOnly": true, + "type": "string" + }, + "port": { + "description": "Output only. The port number of the exposed Redis endpoint.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "ExportInstanceRequest": { "description": "Request for Export.", "id": "ExportInstanceRequest", @@ -1270,6 +1405,22 @@ }, "type": "object" }, + "PrivateServiceConnect": { + "description": "Contains private service connect specific options.", + "id": "PrivateServiceConnect", + "properties": { + "pscService": { + "description": "Output only. The address of the Private Service Connect (PSC) service that the customer can use to connect this instance to their local network.", + "readOnly": true, + "type": "string" + }, + "pscServiceRoute": { + "description": "Optional. The service route to connect using Private Service Connect. On Instance creation, this will automatically connect this route to this instance.", + "type": "string" + } + }, + "type": "object" + }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index 8d3fa3682d9..fa96d19e66d 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -631,7 +631,7 @@ } } }, - "revision": "20211130", + "revision": "20211221", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json index 79289b2f138..52974364c23 100644 --- a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json +++ b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json @@ -499,7 +499,7 @@ } } }, - "revision": "20211203", + "revision": "20211216", "rootUrl": "https://resourcesettings.googleapis.com/", "schemas": { "GoogleCloudResourcesettingsV1ListSettingsResponse": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index 3f8d2fe6074..2678d8615fd 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -1007,7 +1007,7 @@ } } }, - "revision": "20211203", + "revision": "20211210", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1429,7 +1429,7 @@ "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#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.", + "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. Supported values for control imports: * 'control' (default): One JSON Control per line.", "type": "string" }, "inputUris": { @@ -1826,7 +1826,7 @@ "type": "number" }, "price": { - "description": "Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification).", + "description": "Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price).", "format": "float", "type": "number" }, @@ -2405,7 +2405,7 @@ "type": "array" }, "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 logs in or 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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" } }, @@ -2741,7 +2741,7 @@ "description": "Required. The inventory information to update. The allowable fields to update are: * Product.price_info * Product.availability * Product.available_quantity * Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time. The last update time is recorded for the following inventory fields: * Product.price_info * Product.availability * Product.available_quantity * Product.fulfillment_info If a full overwrite of inventory information while ignoring timestamps is needed, UpdateProduct should be invoked instead." }, "setMask": { - "description": "Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.", + "description": "Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.", "format": "google-fieldmask", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index f6074405ca9..cbc023e6a02 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -1096,7 +1096,7 @@ } } }, - "revision": "20211203", + "revision": "20211210", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1815,7 +1815,7 @@ "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#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.", + "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. Supported values for control imports: * 'control' (default): One JSON Control per line.", "type": "string" }, "inputUris": { @@ -2117,7 +2117,7 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2alphaCustomAttribute" }, - "description": "Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * The max number of values per attribute is 10. * For text values, the length limit is 64 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", + "description": "Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * The max number of values per attribute is 10. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", "type": "object" }, "placeId": { @@ -2284,7 +2284,7 @@ "type": "number" }, "price": { - "description": "Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification).", + "description": "Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price).", "format": "float", "type": "number" }, @@ -2916,7 +2916,7 @@ "type": "array" }, "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 logs in or 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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" } }, @@ -3252,7 +3252,7 @@ "description": "Required. The inventory information to update. The allowable fields to update are: * Product.price_info * Product.availability * Product.available_quantity * Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time. The last update time is recorded for the following inventory fields: * Product.price_info * Product.availability * Product.available_quantity * Product.fulfillment_info If a full overwrite of inventory information while ignoring timestamps is needed, UpdateProduct should be invoked instead." }, "setMask": { - "description": "Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.", + "description": "Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.", "format": "google-fieldmask", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index a17a8ada221..0a0e4359f40 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -1007,7 +1007,7 @@ } } }, - "revision": "20211203", + "revision": "20211210", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1971,7 +1971,7 @@ "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#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.", + "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. Supported values for control imports: * 'control' (default): One JSON Control per line.", "type": "string" }, "inputUris": { @@ -2368,7 +2368,7 @@ "type": "number" }, "price": { - "description": "Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification).", + "description": "Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price).", "format": "float", "type": "number" }, @@ -2947,7 +2947,7 @@ "type": "array" }, "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 logs in or 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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" } }, @@ -3283,7 +3283,7 @@ "description": "Required. The inventory information to update. The allowable fields to update are: * Product.price_info * Product.availability * Product.available_quantity * Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time. The last update time is recorded for the following inventory fields: * Product.price_info * Product.availability * Product.available_quantity * Product.fulfillment_info If a full overwrite of inventory information while ignoring timestamps is needed, UpdateProduct should be invoked instead." }, "setMask": { - "description": "Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.", + "description": "Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.", "format": "google-fieldmask", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 7773de9b738..98b54c6a6fa 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -1768,7 +1768,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "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 0dd523b26ef..214ec78a5f2 100644 --- a/googleapiclient/discovery_cache/documents/run.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/run.v1alpha1.json @@ -268,7 +268,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://run.googleapis.com/", "schemas": { "ConfigMapEnvSource": { diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json index 390d86243f8..44396d1aed4 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json @@ -210,7 +210,7 @@ } } }, - "revision": "20211118", + "revision": "20211213", "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 0defc7f584b..6a13a20c4ca 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json @@ -805,7 +805,7 @@ } } }, - "revision": "20211118", + "revision": "20211213", "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 fc4025ddb55..dab6104851c 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleProtobufEmpty": { diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json index b20c538c423..f1788c7ca84 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -887,7 +887,7 @@ } } }, - "revision": "20211125", + "revision": "20211213", "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 812e66bc793..adad867a1ea 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -373,7 +373,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "ApiDataRow": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 2af92703a22..0f6c99e057c 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -2587,9 +2587,40 @@ } } }, - "revision": "20211112", + "revision": "20211213", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { + "Access": { + "description": "Represents an access event.", + "id": "Access", + "properties": { + "callerIp": { + "description": "Caller's IP address, such as \"1.1.1.1\".", + "type": "string" + }, + "callerIpGeo": { + "$ref": "Geolocation", + "description": "The caller IP's geolocation, which identifies where the call came from." + }, + "methodName": { + "description": "The method that the service account called, e.g. \"SetIamPolicy\".", + "type": "string" + }, + "principalEmail": { + "description": "Associated email, such as \"foo@google.com\".", + "type": "string" + }, + "serviceName": { + "description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", + "type": "string" + }, + "userAgentFamily": { + "description": "What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc.", + "type": "string" + } + }, + "type": "object" + }, "Asset": { "description": "Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.", "id": "Asset", @@ -2945,6 +2976,10 @@ "description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "Finding", "properties": { + "access": { + "$ref": "Access", + "description": "Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc." + }, "canonicalName": { "description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" @@ -2999,6 +3034,10 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an Indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise" }, + "mitreAttack": { + "$ref": "MitreAttack", + "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" + }, "mute": { "description": "Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined).", "enum": [ @@ -3103,6 +3142,17 @@ }, "type": "object" }, + "Geolocation": { + "description": "Represents a geographical location for a given access.", + "id": "Geolocation", + "properties": { + "regionCode": { + "description": "A CLDR.", + "type": "string" + } + }, + "type": "object" + }, "GetIamPolicyRequest": { "description": "Request message for `GetIamPolicy` method.", "id": "GetIamPolicyRequest", @@ -3126,6 +3176,12 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { + "description": "The response to a BulkMute request. Contains the LRO information.", + "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudSecuritycenterV1ExternalSystem": { "description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV1ExternalSystem", @@ -3883,6 +3939,226 @@ }, "type": "object" }, + "MitreAttack": { + "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", + "id": "MitreAttack", + "properties": { + "additionalTactics": { + "description": "Additional MITRE ATT&CK tactics related to this finding, if any.", + "items": { + "enum": [ + "TACTIC_UNSPECIFIED", + "RECONNAISSANCE", + "RESOURCE_DEVELOPMENT", + "INITIAL_ACCESS", + "EXECUTION", + "PERSISTENCE", + "PRIVILEGE_ESCALATION", + "DEFENSE_EVASION", + "CREDENTIAL_ACCESS", + "DISCOVERY", + "LATERAL_MOVEMENT", + "COLLECTION", + "COMMAND_AND_CONTROL", + "EXFILTRATION", + "IMPACT" + ], + "enumDescriptions": [ + "Unspecified value.", + "TA0043", + "TA0042", + "TA0001", + "TA0002", + "TA0003", + "TA0004", + "TA0005", + "TA0006", + "TA0007", + "TA0008", + "TA0009", + "TA0011", + "TA0010", + "TA0040" + ], + "type": "string" + }, + "type": "array" + }, + "additionalTechniques": { + "description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", + "items": { + "enum": [ + "TECHNIQUE_UNSPECIFIED", + "ACTIVE_SCANNING", + "SCANNING_IP_BLOCKS", + "INGRESS_TOOL_TRANSFER", + "NATIVE_API", + "SHARED_MODULES", + "COMMAND_AND_SCRIPTING_INTERPRETER", + "UNIX_SHELL", + "RESOURCE_HIJACKING", + "PROXY", + "EXTERNAL_PROXY", + "MULTI_HOP_PROXY", + "DYNAMIC_RESOLUTION", + "UNSECURED_CREDENTIALS", + "VALID_ACCOUNTS", + "LOCAL_ACCOUNTS", + "CLOUD_ACCOUNTS", + "NETWORK_DENIAL_OF_SERVICE", + "PERMISSION_GROUPS_DISCOVERY", + "CLOUD_GROUPS", + "EXFILTRATION_OVER_WEB_SERVICE", + "EXFILTRATION_TO_CLOUD_STORAGE", + "ACCOUNT_MANIPULATION", + "SSH_AUTHORIZED_KEYS", + "CREATE_OR_MODIFY_SYSTEM_PROCESS", + "STEAL_WEB_SESSION_COOKIE", + "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE" + ], + "enumDescriptions": [ + "Unspecified value.", + "T1595", + "T1595.001", + "T1105", + "T1106", + "T1129", + "T1059", + "T1059.004", + "T1496", + "T1090", + "T1090.002", + "T1090.003", + "T1568", + "T1552", + "T1078", + "T1078.003", + "T1078.004", + "T1498", + "T1069", + "T1069.003", + "T1567", + "T1567.002", + "T1098", + "T1098.004", + "T1543", + "T1539", + "T1578" + ], + "type": "string" + }, + "type": "array" + }, + "primaryTactic": { + "description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", + "enum": [ + "TACTIC_UNSPECIFIED", + "RECONNAISSANCE", + "RESOURCE_DEVELOPMENT", + "INITIAL_ACCESS", + "EXECUTION", + "PERSISTENCE", + "PRIVILEGE_ESCALATION", + "DEFENSE_EVASION", + "CREDENTIAL_ACCESS", + "DISCOVERY", + "LATERAL_MOVEMENT", + "COLLECTION", + "COMMAND_AND_CONTROL", + "EXFILTRATION", + "IMPACT" + ], + "enumDescriptions": [ + "Unspecified value.", + "TA0043", + "TA0042", + "TA0001", + "TA0002", + "TA0003", + "TA0004", + "TA0005", + "TA0006", + "TA0007", + "TA0008", + "TA0009", + "TA0011", + "TA0010", + "TA0040" + ], + "type": "string" + }, + "primaryTechniques": { + "description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING).", + "items": { + "enum": [ + "TECHNIQUE_UNSPECIFIED", + "ACTIVE_SCANNING", + "SCANNING_IP_BLOCKS", + "INGRESS_TOOL_TRANSFER", + "NATIVE_API", + "SHARED_MODULES", + "COMMAND_AND_SCRIPTING_INTERPRETER", + "UNIX_SHELL", + "RESOURCE_HIJACKING", + "PROXY", + "EXTERNAL_PROXY", + "MULTI_HOP_PROXY", + "DYNAMIC_RESOLUTION", + "UNSECURED_CREDENTIALS", + "VALID_ACCOUNTS", + "LOCAL_ACCOUNTS", + "CLOUD_ACCOUNTS", + "NETWORK_DENIAL_OF_SERVICE", + "PERMISSION_GROUPS_DISCOVERY", + "CLOUD_GROUPS", + "EXFILTRATION_OVER_WEB_SERVICE", + "EXFILTRATION_TO_CLOUD_STORAGE", + "ACCOUNT_MANIPULATION", + "SSH_AUTHORIZED_KEYS", + "CREATE_OR_MODIFY_SYSTEM_PROCESS", + "STEAL_WEB_SESSION_COOKIE", + "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE" + ], + "enumDescriptions": [ + "Unspecified value.", + "T1595", + "T1595.001", + "T1105", + "T1106", + "T1129", + "T1059", + "T1059.004", + "T1496", + "T1090", + "T1090.002", + "T1090.003", + "T1568", + "T1552", + "T1078", + "T1078.003", + "T1078.004", + "T1498", + "T1069", + "T1069.003", + "T1567", + "T1567.002", + "T1098", + "T1098.004", + "T1543", + "T1539", + "T1578" + ], + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", + "type": "string" + } + }, + "type": "object" + }, "NotificationConfig": { "description": "Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.", "id": "NotificationConfig", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 017b9588ec8..aeb0ea2a6fd 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,9 +896,40 @@ } } }, - "revision": "20211112", + "revision": "20211213", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { + "Access": { + "description": "Represents an access event.", + "id": "Access", + "properties": { + "callerIp": { + "description": "Caller's IP address, such as \"1.1.1.1\".", + "type": "string" + }, + "callerIpGeo": { + "$ref": "Geolocation", + "description": "The caller IP's geolocation, which identifies where the call came from." + }, + "methodName": { + "description": "The method that the service account called, e.g. \"SetIamPolicy\".", + "type": "string" + }, + "principalEmail": { + "description": "Associated email, such as \"foo@google.com\".", + "type": "string" + }, + "serviceName": { + "description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", + "type": "string" + }, + "userAgentFamily": { + "description": "What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc.", + "type": "string" + } + }, + "type": "object" + }, "Asset": { "description": "Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.", "id": "Asset", @@ -1230,6 +1261,10 @@ "description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "Finding", "properties": { + "access": { + "$ref": "Access", + "description": "Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc." + }, "canonicalName": { "description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" @@ -1284,6 +1319,10 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an Indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise" }, + "mitreAttack": { + "$ref": "MitreAttack", + "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" + }, "mute": { "description": "Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined).", "enum": [ @@ -1388,6 +1427,17 @@ }, "type": "object" }, + "Geolocation": { + "description": "Represents a geographical location for a given access.", + "id": "Geolocation", + "properties": { + "regionCode": { + "description": "A CLDR.", + "type": "string" + } + }, + "type": "object" + }, "GetIamPolicyRequest": { "description": "Request message for `GetIamPolicy` method.", "id": "GetIamPolicyRequest", @@ -1411,6 +1461,12 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { + "description": "The response to a BulkMute request. Contains the LRO information.", + "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudSecuritycenterV1ExternalSystem": { "description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV1ExternalSystem", @@ -2155,6 +2211,226 @@ }, "type": "object" }, + "MitreAttack": { + "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", + "id": "MitreAttack", + "properties": { + "additionalTactics": { + "description": "Additional MITRE ATT&CK tactics related to this finding, if any.", + "items": { + "enum": [ + "TACTIC_UNSPECIFIED", + "RECONNAISSANCE", + "RESOURCE_DEVELOPMENT", + "INITIAL_ACCESS", + "EXECUTION", + "PERSISTENCE", + "PRIVILEGE_ESCALATION", + "DEFENSE_EVASION", + "CREDENTIAL_ACCESS", + "DISCOVERY", + "LATERAL_MOVEMENT", + "COLLECTION", + "COMMAND_AND_CONTROL", + "EXFILTRATION", + "IMPACT" + ], + "enumDescriptions": [ + "Unspecified value.", + "TA0043", + "TA0042", + "TA0001", + "TA0002", + "TA0003", + "TA0004", + "TA0005", + "TA0006", + "TA0007", + "TA0008", + "TA0009", + "TA0011", + "TA0010", + "TA0040" + ], + "type": "string" + }, + "type": "array" + }, + "additionalTechniques": { + "description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", + "items": { + "enum": [ + "TECHNIQUE_UNSPECIFIED", + "ACTIVE_SCANNING", + "SCANNING_IP_BLOCKS", + "INGRESS_TOOL_TRANSFER", + "NATIVE_API", + "SHARED_MODULES", + "COMMAND_AND_SCRIPTING_INTERPRETER", + "UNIX_SHELL", + "RESOURCE_HIJACKING", + "PROXY", + "EXTERNAL_PROXY", + "MULTI_HOP_PROXY", + "DYNAMIC_RESOLUTION", + "UNSECURED_CREDENTIALS", + "VALID_ACCOUNTS", + "LOCAL_ACCOUNTS", + "CLOUD_ACCOUNTS", + "NETWORK_DENIAL_OF_SERVICE", + "PERMISSION_GROUPS_DISCOVERY", + "CLOUD_GROUPS", + "EXFILTRATION_OVER_WEB_SERVICE", + "EXFILTRATION_TO_CLOUD_STORAGE", + "ACCOUNT_MANIPULATION", + "SSH_AUTHORIZED_KEYS", + "CREATE_OR_MODIFY_SYSTEM_PROCESS", + "STEAL_WEB_SESSION_COOKIE", + "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE" + ], + "enumDescriptions": [ + "Unspecified value.", + "T1595", + "T1595.001", + "T1105", + "T1106", + "T1129", + "T1059", + "T1059.004", + "T1496", + "T1090", + "T1090.002", + "T1090.003", + "T1568", + "T1552", + "T1078", + "T1078.003", + "T1078.004", + "T1498", + "T1069", + "T1069.003", + "T1567", + "T1567.002", + "T1098", + "T1098.004", + "T1543", + "T1539", + "T1578" + ], + "type": "string" + }, + "type": "array" + }, + "primaryTactic": { + "description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", + "enum": [ + "TACTIC_UNSPECIFIED", + "RECONNAISSANCE", + "RESOURCE_DEVELOPMENT", + "INITIAL_ACCESS", + "EXECUTION", + "PERSISTENCE", + "PRIVILEGE_ESCALATION", + "DEFENSE_EVASION", + "CREDENTIAL_ACCESS", + "DISCOVERY", + "LATERAL_MOVEMENT", + "COLLECTION", + "COMMAND_AND_CONTROL", + "EXFILTRATION", + "IMPACT" + ], + "enumDescriptions": [ + "Unspecified value.", + "TA0043", + "TA0042", + "TA0001", + "TA0002", + "TA0003", + "TA0004", + "TA0005", + "TA0006", + "TA0007", + "TA0008", + "TA0009", + "TA0011", + "TA0010", + "TA0040" + ], + "type": "string" + }, + "primaryTechniques": { + "description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING).", + "items": { + "enum": [ + "TECHNIQUE_UNSPECIFIED", + "ACTIVE_SCANNING", + "SCANNING_IP_BLOCKS", + "INGRESS_TOOL_TRANSFER", + "NATIVE_API", + "SHARED_MODULES", + "COMMAND_AND_SCRIPTING_INTERPRETER", + "UNIX_SHELL", + "RESOURCE_HIJACKING", + "PROXY", + "EXTERNAL_PROXY", + "MULTI_HOP_PROXY", + "DYNAMIC_RESOLUTION", + "UNSECURED_CREDENTIALS", + "VALID_ACCOUNTS", + "LOCAL_ACCOUNTS", + "CLOUD_ACCOUNTS", + "NETWORK_DENIAL_OF_SERVICE", + "PERMISSION_GROUPS_DISCOVERY", + "CLOUD_GROUPS", + "EXFILTRATION_OVER_WEB_SERVICE", + "EXFILTRATION_TO_CLOUD_STORAGE", + "ACCOUNT_MANIPULATION", + "SSH_AUTHORIZED_KEYS", + "CREATE_OR_MODIFY_SYSTEM_PROCESS", + "STEAL_WEB_SESSION_COOKIE", + "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE" + ], + "enumDescriptions": [ + "Unspecified value.", + "T1595", + "T1595.001", + "T1105", + "T1106", + "T1129", + "T1059", + "T1059.004", + "T1496", + "T1090", + "T1090.002", + "T1090.003", + "T1568", + "T1552", + "T1078", + "T1078.003", + "T1078.004", + "T1498", + "T1069", + "T1069.003", + "T1567", + "T1567.002", + "T1098", + "T1098.004", + "T1543", + "T1539", + "T1578" + ], + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index d66feb79cd5..5c220f748cb 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -182,6 +182,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getVirtualMachineThreatDetectionSettings": { + "description": "Get the VirtualMachineThreatDetectionSettings resource.", + "flatPath": "v1beta2/folders/{foldersId}/virtualMachineThreatDetectionSettings", + "httpMethod": "GET", + "id": "securitycenter.folders.getVirtualMachineThreatDetectionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getWebSecurityScannerSettings": { "description": "Get the WebSecurityScannerSettings resource.", "flatPath": "v1beta2/folders/{foldersId}/webSecurityScannerSettings", @@ -309,6 +334,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateVirtualMachineThreatDetectionSettings": { + "description": "Update the VirtualMachineThreatDetectionSettings resource.", + "flatPath": "v1beta2/folders/{foldersId}/virtualMachineThreatDetectionSettings", + "httpMethod": "PATCH", + "id": "securitycenter.folders.updateVirtualMachineThreatDetectionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "request": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateWebSecurityScannerSettings": { "description": "Update the WebSecurityScannerSettings resource.", "flatPath": "v1beta2/folders/{foldersId}/webSecurityScannerSettings", @@ -432,6 +491,35 @@ } } }, + "virtualMachineThreatDetectionSettings": { + "methods": { + "calculate": { + "description": "Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.", + "flatPath": "v1beta2/folders/{foldersId}/virtualMachineThreatDetectionSettings:calculate", + "httpMethod": "GET", + "id": "securitycenter.folders.virtualMachineThreatDetectionSettings.calculate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:calculate", + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "webSecurityScannerSettings": { "methods": { "calculate": { @@ -590,6 +678,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getVirtualMachineThreatDetectionSettings": { + "description": "Get the VirtualMachineThreatDetectionSettings resource.", + "flatPath": "v1beta2/organizations/{organizationsId}/virtualMachineThreatDetectionSettings", + "httpMethod": "GET", + "id": "securitycenter.organizations.getVirtualMachineThreatDetectionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getWebSecurityScannerSettings": { "description": "Get the WebSecurityScannerSettings resource.", "flatPath": "v1beta2/organizations/{organizationsId}/webSecurityScannerSettings", @@ -717,6 +830,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateVirtualMachineThreatDetectionSettings": { + "description": "Update the VirtualMachineThreatDetectionSettings resource.", + "flatPath": "v1beta2/organizations/{organizationsId}/virtualMachineThreatDetectionSettings", + "httpMethod": "PATCH", + "id": "securitycenter.organizations.updateVirtualMachineThreatDetectionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "request": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateWebSecurityScannerSettings": { "description": "Update the WebSecurityScannerSettings resource.", "flatPath": "v1beta2/organizations/{organizationsId}/webSecurityScannerSettings", @@ -840,6 +987,35 @@ } } }, + "virtualMachineThreatDetectionSettings": { + "methods": { + "calculate": { + "description": "Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.", + "flatPath": "v1beta2/organizations/{organizationsId}/virtualMachineThreatDetectionSettings:calculate", + "httpMethod": "GET", + "id": "securitycenter.organizations.virtualMachineThreatDetectionSettings.calculate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:calculate", + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "webSecurityScannerSettings": { "methods": { "calculate": { @@ -948,6 +1124,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getVirtualMachineThreatDetectionSettings": { + "description": "Get the VirtualMachineThreatDetectionSettings resource.", + "flatPath": "v1beta2/projects/{projectsId}/virtualMachineThreatDetectionSettings", + "httpMethod": "GET", + "id": "securitycenter.projects.getVirtualMachineThreatDetectionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getWebSecurityScannerSettings": { "description": "Get the WebSecurityScannerSettings resource.", "flatPath": "v1beta2/projects/{projectsId}/webSecurityScannerSettings", @@ -1075,6 +1276,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateVirtualMachineThreatDetectionSettings": { + "description": "Update the VirtualMachineThreatDetectionSettings resource.", + "flatPath": "v1beta2/projects/{projectsId}/virtualMachineThreatDetectionSettings", + "httpMethod": "PATCH", + "id": "securitycenter.projects.updateVirtualMachineThreatDetectionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta2/{+name}", + "request": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateWebSecurityScannerSettings": { "description": "Update the WebSecurityScannerSettings resource.", "flatPath": "v1beta2/projects/{projectsId}/webSecurityScannerSettings", @@ -1296,6 +1531,35 @@ } } }, + "virtualMachineThreatDetectionSettings": { + "methods": { + "calculate": { + "description": "Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings.", + "flatPath": "v1beta2/projects/{projectsId}/virtualMachineThreatDetectionSettings:calculate", + "httpMethod": "GET", + "id": "securitycenter.projects.virtualMachineThreatDetectionSettings.calculate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "location": "path", + "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1beta2/{+name}:calculate", + "response": { + "$ref": "VirtualMachineThreatDetectionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "webSecurityScannerSettings": { "methods": { "calculate": { @@ -1328,9 +1592,40 @@ } } }, - "revision": "20211112", + "revision": "20211213", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { + "Access": { + "description": "Represents an access event.", + "id": "Access", + "properties": { + "callerIp": { + "description": "Caller's IP address, such as \"1.1.1.1\".", + "type": "string" + }, + "callerIpGeo": { + "$ref": "Geolocation", + "description": "The caller IP's geolocation, which identifies where the call came from." + }, + "methodName": { + "description": "The method that the service account called, e.g. \"SetIamPolicy\".", + "type": "string" + }, + "principalEmail": { + "description": "Associated email, such as \"foo@google.com\".", + "type": "string" + }, + "serviceName": { + "description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", + "type": "string" + }, + "userAgentFamily": { + "description": "What kind of user agent is associated, e.g. operating system shells, embedded or stand-alone applications, etc.", + "type": "string" + } + }, + "type": "object" + }, "Config": { "description": "Configuration of a module.", "id": "Config", @@ -1644,6 +1939,10 @@ "description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "Finding", "properties": { + "access": { + "$ref": "Access", + "description": "Access details associated to the Finding, such as more information on the caller, which method was accessed, from where, etc." + }, "canonicalName": { "description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" @@ -1698,6 +1997,10 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an Indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise" }, + "mitreAttack": { + "$ref": "MitreAttack", + "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" + }, "mute": { "description": "Indicates the mute state of a finding (either unspecified, muted, unmuted or undefined).", "enum": [ @@ -1802,6 +2105,23 @@ }, "type": "object" }, + "Geolocation": { + "description": "Represents a geographical location for a given access.", + "id": "Geolocation", + "properties": { + "regionCode": { + "description": "A CLDR.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { + "description": "The response to a BulkMute request. Contains the LRO information.", + "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudSecuritycenterV1ExternalSystem": { "description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV1ExternalSystem", @@ -2216,6 +2536,226 @@ }, "type": "object" }, + "MitreAttack": { + "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", + "id": "MitreAttack", + "properties": { + "additionalTactics": { + "description": "Additional MITRE ATT&CK tactics related to this finding, if any.", + "items": { + "enum": [ + "TACTIC_UNSPECIFIED", + "RECONNAISSANCE", + "RESOURCE_DEVELOPMENT", + "INITIAL_ACCESS", + "EXECUTION", + "PERSISTENCE", + "PRIVILEGE_ESCALATION", + "DEFENSE_EVASION", + "CREDENTIAL_ACCESS", + "DISCOVERY", + "LATERAL_MOVEMENT", + "COLLECTION", + "COMMAND_AND_CONTROL", + "EXFILTRATION", + "IMPACT" + ], + "enumDescriptions": [ + "Unspecified value.", + "TA0043", + "TA0042", + "TA0001", + "TA0002", + "TA0003", + "TA0004", + "TA0005", + "TA0006", + "TA0007", + "TA0008", + "TA0009", + "TA0011", + "TA0010", + "TA0040" + ], + "type": "string" + }, + "type": "array" + }, + "additionalTechniques": { + "description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", + "items": { + "enum": [ + "TECHNIQUE_UNSPECIFIED", + "ACTIVE_SCANNING", + "SCANNING_IP_BLOCKS", + "INGRESS_TOOL_TRANSFER", + "NATIVE_API", + "SHARED_MODULES", + "COMMAND_AND_SCRIPTING_INTERPRETER", + "UNIX_SHELL", + "RESOURCE_HIJACKING", + "PROXY", + "EXTERNAL_PROXY", + "MULTI_HOP_PROXY", + "DYNAMIC_RESOLUTION", + "UNSECURED_CREDENTIALS", + "VALID_ACCOUNTS", + "LOCAL_ACCOUNTS", + "CLOUD_ACCOUNTS", + "NETWORK_DENIAL_OF_SERVICE", + "PERMISSION_GROUPS_DISCOVERY", + "CLOUD_GROUPS", + "EXFILTRATION_OVER_WEB_SERVICE", + "EXFILTRATION_TO_CLOUD_STORAGE", + "ACCOUNT_MANIPULATION", + "SSH_AUTHORIZED_KEYS", + "CREATE_OR_MODIFY_SYSTEM_PROCESS", + "STEAL_WEB_SESSION_COOKIE", + "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE" + ], + "enumDescriptions": [ + "Unspecified value.", + "T1595", + "T1595.001", + "T1105", + "T1106", + "T1129", + "T1059", + "T1059.004", + "T1496", + "T1090", + "T1090.002", + "T1090.003", + "T1568", + "T1552", + "T1078", + "T1078.003", + "T1078.004", + "T1498", + "T1069", + "T1069.003", + "T1567", + "T1567.002", + "T1098", + "T1098.004", + "T1543", + "T1539", + "T1578" + ], + "type": "string" + }, + "type": "array" + }, + "primaryTactic": { + "description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", + "enum": [ + "TACTIC_UNSPECIFIED", + "RECONNAISSANCE", + "RESOURCE_DEVELOPMENT", + "INITIAL_ACCESS", + "EXECUTION", + "PERSISTENCE", + "PRIVILEGE_ESCALATION", + "DEFENSE_EVASION", + "CREDENTIAL_ACCESS", + "DISCOVERY", + "LATERAL_MOVEMENT", + "COLLECTION", + "COMMAND_AND_CONTROL", + "EXFILTRATION", + "IMPACT" + ], + "enumDescriptions": [ + "Unspecified value.", + "TA0043", + "TA0042", + "TA0001", + "TA0002", + "TA0003", + "TA0004", + "TA0005", + "TA0006", + "TA0007", + "TA0008", + "TA0009", + "TA0011", + "TA0010", + "TA0040" + ], + "type": "string" + }, + "primaryTechniques": { + "description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. SCANNING_IP_BLOCKS), both the sub-technique and its parent technique(s) will be listed (e.g. SCANNING_IP_BLOCKS, ACTIVE_SCANNING).", + "items": { + "enum": [ + "TECHNIQUE_UNSPECIFIED", + "ACTIVE_SCANNING", + "SCANNING_IP_BLOCKS", + "INGRESS_TOOL_TRANSFER", + "NATIVE_API", + "SHARED_MODULES", + "COMMAND_AND_SCRIPTING_INTERPRETER", + "UNIX_SHELL", + "RESOURCE_HIJACKING", + "PROXY", + "EXTERNAL_PROXY", + "MULTI_HOP_PROXY", + "DYNAMIC_RESOLUTION", + "UNSECURED_CREDENTIALS", + "VALID_ACCOUNTS", + "LOCAL_ACCOUNTS", + "CLOUD_ACCOUNTS", + "NETWORK_DENIAL_OF_SERVICE", + "PERMISSION_GROUPS_DISCOVERY", + "CLOUD_GROUPS", + "EXFILTRATION_OVER_WEB_SERVICE", + "EXFILTRATION_TO_CLOUD_STORAGE", + "ACCOUNT_MANIPULATION", + "SSH_AUTHORIZED_KEYS", + "CREATE_OR_MODIFY_SYSTEM_PROCESS", + "STEAL_WEB_SESSION_COOKIE", + "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE" + ], + "enumDescriptions": [ + "Unspecified value.", + "T1595", + "T1595.001", + "T1105", + "T1106", + "T1129", + "T1059", + "T1059.004", + "T1496", + "T1090", + "T1090.002", + "T1090.003", + "T1568", + "T1552", + "T1078", + "T1078.003", + "T1078.004", + "T1498", + "T1069", + "T1069.003", + "T1567", + "T1567.002", + "T1098", + "T1098.004", + "T1543", + "T1539", + "T1578" + ], + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", + "type": "string" + } + }, + "type": "object" + }, "Reference": { "description": "Additional Links", "id": "Reference", @@ -2346,6 +2886,51 @@ }, "type": "object" }, + "VirtualMachineThreatDetectionSettings": { + "description": "Resource capturing the settings for the Virtual Machine Threat Detection service.", + "id": "VirtualMachineThreatDetectionSettings", + "properties": { + "modules": { + "additionalProperties": { + "$ref": "Config" + }, + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "type": "object" + }, + "name": { + "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "type": "string" + }, + "serviceAccount": { + "description": "Output only. The service account used by Virtual Machine Threat Detection detectors.", + "readOnly": true, + "type": "string" + }, + "serviceEnablementState": { + "description": "The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.", + "enum": [ + "ENABLEMENT_STATE_UNSPECIFIED", + "INHERITED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "State is inherited from the parent resource.", + "State is enabled.", + "State is disabled." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the settings were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Vulnerability": { "description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "Vulnerability", diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index b48098333af..77d9d04689e 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20211112", + "revision": "20211215", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -909,11 +909,11 @@ "type": "object" }, "Control": { - "description": "Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.", + "description": "Selects and configures the service controller used by the service. The service controller handles two things: - **What is allowed:** for each API request, Chemist checks the project status, activation status, abuse status, billing status, service status, location restrictions, VPC Service Controls, SuperQuota, and other policies. - **What has happened:** for each API response, Chemist reports the telemetry data to analytics, auditing, billing, eventing, logging, monitoring, sawmill, and tracing. Chemist also accepts telemetry data not associated with API traffic, such as billing metrics. Example: control: environment: servicecontrol.googleapis.com", "id": "Control", "properties": { "environment": { - "description": "The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.", + "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index eac96f0c51e..619d0bef4c6 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -500,7 +500,7 @@ } } }, - "revision": "20211112", + "revision": "20211215", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -801,11 +801,11 @@ "type": "object" }, "Control": { - "description": "Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.", + "description": "Selects and configures the service controller used by the service. The service controller handles two things: - **What is allowed:** for each API request, Chemist checks the project status, activation status, abuse status, billing status, service status, location restrictions, VPC Service Controls, SuperQuota, and other policies. - **What has happened:** for each API response, Chemist reports the telemetry data to analytics, auditing, billing, eventing, logging, monitoring, sawmill, and tracing. Chemist also accepts telemetry data not associated with API traffic, such as billing metrics. Example: control: environment: servicecontrol.googleapis.com", "id": "Control", "properties": { "environment": { - "description": "The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.", + "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", "type": "string" } }, @@ -2153,6 +2153,13 @@ }, "type": "array" }, + "supportedLocations": { + "description": "List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.", + "items": { + "type": "string" + }, + "type": "array" + }, "unit": { "description": "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.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index 84a81cd5a49..b49d63079a1 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20211104", + "revision": "20211130", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index 9bab7c22286..f90bb11cbae 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -169,7 +169,7 @@ } } }, - "revision": "20211104", + "revision": "20211130", "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 baf82fbd115..d0484007233 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -883,7 +883,7 @@ } } }, - "revision": "20211110", + "revision": "20211202", "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 ac2e66163c6..85cce1dbb9d 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -883,7 +883,7 @@ } } }, - "revision": "20211110", + "revision": "20211202", "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 a5c1a4489d8..bf3258f6b46 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -829,7 +829,7 @@ } } }, - "revision": "20211112", + "revision": "20211203", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 1cd1e51d438..30b94009c79 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -860,7 +860,7 @@ } } }, - "revision": "20211203", + "revision": "20211222", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1442,11 +1442,11 @@ "type": "object" }, "Control": { - "description": "Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.", + "description": "Selects and configures the service controller used by the service. The service controller handles two things: - **What is allowed:** for each API request, Chemist checks the project status, activation status, abuse status, billing status, service status, location restrictions, VPC Service Controls, SuperQuota, and other policies. - **What has happened:** for each API response, Chemist reports the telemetry data to analytics, auditing, billing, eventing, logging, monitoring, sawmill, and tracing. Chemist also accepts telemetry data not associated with API traffic, such as billing metrics. Example: control: environment: servicecontrol.googleapis.com", "id": "Control", "properties": { "environment": { - "description": "The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.", + "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", "type": "string" } }, @@ -3261,6 +3261,10 @@ "ValidateConsumerConfigRequest": { "id": "ValidateConsumerConfigRequest", "properties": { + "checkServiceNetworkingUsePermission": { + "description": "Optional. The IAM permission check determines whether the consumer project has 'servicenetworking.services.use' permission or not.", + "type": "boolean" + }, "consumerNetwork": { "description": "Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is network name.", "type": "string" @@ -3310,7 +3314,8 @@ "RANGES_EXHAUSTED", "RANGES_NOT_RESERVED", "RANGES_DELETED_LATER", - "COMPUTE_API_NOT_ENABLED" + "COMPUTE_API_NOT_ENABLED", + "USE_PERMISSION_NOT_FOUND" ], "enumDescriptions": [ "", @@ -3326,7 +3331,8 @@ "The reserved IP ranges do not have enough space to create a subnet of desired size.", "The IP ranges were not reserved.", "The IP ranges were reserved but deleted later.", - "The consumer project does not have the compute api enabled." + "The consumer project does not have the compute api enabled.", + "The consumer project does not have the permission from the host project." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index d8243dc491b..093ea116f20 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20211203", + "revision": "20211222", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -789,11 +789,11 @@ "type": "object" }, "Control": { - "description": "Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.", + "description": "Selects and configures the service controller used by the service. The service controller handles two things: - **What is allowed:** for each API request, Chemist checks the project status, activation status, abuse status, billing status, service status, location restrictions, VPC Service Controls, SuperQuota, and other policies. - **What has happened:** for each API response, Chemist reports the telemetry data to analytics, auditing, billing, eventing, logging, monitoring, sawmill, and tracing. Chemist also accepts telemetry data not associated with API traffic, such as billing metrics. Example: control: environment: servicecontrol.googleapis.com", "id": "Control", "properties": { "environment": { - "description": "The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.", + "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 898f8ffb2c2..2eafb11d55b 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20211112", + "revision": "20211215", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -845,11 +845,11 @@ "type": "object" }, "Control": { - "description": "Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.", + "description": "Selects and configures the service controller used by the service. The service controller handles two things: - **What is allowed:** for each API request, Chemist checks the project status, activation status, abuse status, billing status, service status, location restrictions, VPC Service Controls, SuperQuota, and other policies. - **What has happened:** for each API response, Chemist reports the telemetry data to analytics, auditing, billing, eventing, logging, monitoring, sawmill, and tracing. Chemist also accepts telemetry data not associated with API traffic, such as billing metrics. Example: control: environment: servicecontrol.googleapis.com", "id": "Control", "properties": { "environment": { - "description": "The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.", + "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index f8e7d5d158e..8f112a1e992 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -959,7 +959,7 @@ } } }, - "revision": "20211112", + "revision": "20211215", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -1331,6 +1331,13 @@ }, "type": "array" }, + "supportedLocations": { + "description": "List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.", + "items": { + "type": "string" + }, + "type": "array" + }, "unit": { "description": "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.", "type": "string" @@ -1429,11 +1436,11 @@ "type": "object" }, "Control": { - "description": "Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.", + "description": "Selects and configures the service controller used by the service. The service controller handles two things: - **What is allowed:** for each API request, Chemist checks the project status, activation status, abuse status, billing status, service status, location restrictions, VPC Service Controls, SuperQuota, and other policies. - **What has happened:** for each API response, Chemist reports the telemetry data to analytics, auditing, billing, eventing, logging, monitoring, sawmill, and tracing. Chemist also accepts telemetry data not associated with API traffic, such as billing metrics. Example: control: environment: servicecontrol.googleapis.com", "id": "Control", "properties": { "environment": { - "description": "The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.", + "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 99daf38115d..728b1b3827f 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20211130", + "revision": "20211214", "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 e4876432625..618bd9afdba 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -313,7 +313,7 @@ } } }, - "revision": "20211130", + "revision": "20211214", "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 ea0250d3af8..591871115fc 100644 --- a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json @@ -355,7 +355,7 @@ } } }, - "revision": "20211119", + "revision": "20211215", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { diff --git a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json index 8633a4bb307..1a7f729f888 100644 --- a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json +++ b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json @@ -266,7 +266,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -450,7 +450,7 @@ } } }, - "revision": "20211012", + "revision": "20211206", "rootUrl": "https://sourcerepo.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index e7d84491632..64272f6c475 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -961,7 +961,7 @@ ] }, "dropDatabase": { - "description": "Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`.", + "description": "Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}", "httpMethod": "DELETE", "id": "spanner.projects.instances.databases.dropDatabase", @@ -2037,7 +2037,7 @@ } } }, - "revision": "20211202", + "revision": "20211203", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Backup": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index f7f183cedd6..f3ceae0a18c 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -187,7 +187,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource where this custom class will be created. Format: {api_version}/projects/{project}/locations/{location}/customClasses", + "description": "Required. The parent resource where this custom class will be created. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -215,7 +215,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the custom class to delete. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class}", + "description": "Required. The name of the custom class to delete. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customClasses/[^/]+$", "required": true, @@ -240,7 +240,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the custom class to retrieve. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class}", + "description": "Required. The name of the custom class to retrieve. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customClasses/[^/]+$", "required": true, @@ -276,7 +276,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns this collection of custom classes. Format: {api_version}/projects/{project}/locations/{location}/customClasses", + "description": "Required. The parent, which owns this collection of custom classes. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -339,7 +339,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource where this phrase set will be created. Format: {api_version}/projects/{project}/locations/{location}/phraseSets", + "description": "Required. The parent resource where this phrase set will be created. Format: `projects/{project}/locations/{location}/phraseSets` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -367,7 +367,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the phrase set to delete. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set}", + "description": "Required. The name of the phrase set to delete. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseSets/[^/]+$", "required": true, @@ -392,7 +392,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the phrase set to retrieve. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set}", + "description": "Required. The name of the phrase set to retrieve. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseSets/[^/]+$", "required": true, @@ -428,7 +428,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns this collection of phrase set. Format: projects/{project}/locations/{location}", + "description": "Required. The parent, which owns this collection of phrase set. Format: `projects/{project}/locations/{location}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -524,7 +524,7 @@ } } }, - "revision": "20211104", + "revision": "20211221", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { @@ -759,7 +759,7 @@ "type": "object" }, "Phrase": { - "description": "A phrases containing words and phrase \"hints\" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. \"i was born in january\", \"i was born in febuary\", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. \"i was born in $month\"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. \"${my-months}\". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`).", + "description": "A phrases containing words and phrase \"hints\" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. \"i was born in january\", \"i was born in febuary\", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. \"i was born in $month\"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. \"${my-months}\". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "id": "Phrase", "properties": { "boost": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index dccdc8df99b..6df0d9d3dd8 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -187,7 +187,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource where this custom class will be created. Format: {api_version}/projects/{project}/locations/{location}/customClasses", + "description": "Required. The parent resource where this custom class will be created. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -215,7 +215,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the custom class to delete. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class}", + "description": "Required. The name of the custom class to delete. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customClasses/[^/]+$", "required": true, @@ -240,7 +240,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the custom class to retrieve. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class}", + "description": "Required. The name of the custom class to retrieve. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customClasses/[^/]+$", "required": true, @@ -276,7 +276,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns this collection of custom classes. Format: {api_version}/projects/{project}/locations/{location}/customClasses", + "description": "Required. The parent, which owns this collection of custom classes. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -339,7 +339,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource where this phrase set will be created. Format: {api_version}/projects/{project}/locations/{location}/phraseSets", + "description": "Required. The parent resource where this phrase set will be created. Format: `projects/{project}/locations/{location}/phraseSets` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -367,7 +367,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the phrase set to delete. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set}", + "description": "Required. The name of the phrase set to delete. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseSets/[^/]+$", "required": true, @@ -392,7 +392,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the phrase set to retrieve. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set}", + "description": "Required. The name of the phrase set to retrieve. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseSets/[^/]+$", "required": true, @@ -428,7 +428,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns this collection of phrase set. Format: projects/{project}/locations/{location}", + "description": "Required. The parent, which owns this collection of phrase set. Format: `projects/{project}/locations/{location}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -524,7 +524,7 @@ } } }, - "revision": "20211104", + "revision": "20211221", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { @@ -783,7 +783,7 @@ "type": "object" }, "Phrase": { - "description": "A phrases containing words and phrase \"hints\" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. \"i was born in january\", \"i was born in febuary\", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. \"i was born in $month\"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. \"${my-months}\". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`).", + "description": "A phrases containing words and phrase \"hints\" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. \"i was born in january\", \"i was born in febuary\", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. \"i was born in $month\"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. \"${my-months}\". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.", "id": "Phrase", "properties": { "boost": { diff --git a/googleapiclient/discovery_cache/documents/speech.v2beta1.json b/googleapiclient/discovery_cache/documents/speech.v2beta1.json index eb3618ab0c7..f2e1d366a95 100644 --- a/googleapiclient/discovery_cache/documents/speech.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v2beta1.json @@ -184,7 +184,7 @@ } } }, - "revision": "20211104", + "revision": "20211221", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ListOperationsResponse": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 5d8dbf3054f..075e0d044da 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -1877,7 +1877,7 @@ } } }, - "revision": "20211116", + "revision": "20211206", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2393,7 +2393,7 @@ "type": "string" }, "databaseInstalledVersion": { - "description": "Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50", + "description": "Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**.", "readOnly": true, "type": "string" }, @@ -2476,7 +2476,7 @@ "type": "object" }, "gceZone": { - "description": "The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.", + "description": "The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.", "type": "string" }, "instanceType": { @@ -3353,7 +3353,7 @@ "type": "string" }, "authorizedNetworks": { - "description": "The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**).", + "description": "The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**).", "items": { "$ref": "AclEntry" }, @@ -3413,7 +3413,7 @@ "id": "LocationPreference", "properties": { "followGaeApplication": { - "description": "The App Engine application to follow, it must be in the same region as the Cloud SQL instance.", + "description": "The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance.", "type": "string" }, "kind": { @@ -3425,7 +3425,7 @@ "type": "string" }, "zone": { - "description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).", + "description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance.", "type": "string" } }, @@ -4019,7 +4019,7 @@ "type": "array" }, "databaseReplicationEnabled": { - "description": "Configuration specific to read replica instances. Indicates whether replication is enabled or not.", + "description": "Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.", "type": "boolean" }, "denyMaintenancePeriods": { @@ -4100,7 +4100,7 @@ "type": "string" }, "tier": { - "description": "The tier (or machine type) for this instance, for example **db-custom-1-3840**.", + "description": "The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance.", "type": "string" }, "userLabels": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 94f3c410f6e..0a10aed9ccf 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -1877,7 +1877,7 @@ } } }, - "revision": "20211116", + "revision": "20211206", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2393,7 +2393,7 @@ "type": "string" }, "databaseInstalledVersion": { - "description": "Output only. The databaseInstalledVersion stores the current fully resolved database version running on the instance including minor version such as MYSQL_5_6_50", + "description": "Output only. Stores the current database version running on the instance including minor version such as **MYSQL_8_0_18**.", "readOnly": true, "type": "string" }, @@ -2476,7 +2476,7 @@ "type": "object" }, "gceZone": { - "description": "The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.", + "description": "The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.", "type": "string" }, "instanceType": { @@ -3353,7 +3353,7 @@ "type": "string" }, "authorizedNetworks": { - "description": "The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**).", + "description": "The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **157.197.200.0/24**).", "items": { "$ref": "AclEntry" }, @@ -3413,7 +3413,7 @@ "id": "LocationPreference", "properties": { "followGaeApplication": { - "description": "The App Engine application to follow, it must be in the same region as the Cloud SQL instance.", + "description": "The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance.", "type": "string" }, "kind": { @@ -3425,7 +3425,7 @@ "type": "string" }, "zone": { - "description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).", + "description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance.", "type": "string" } }, @@ -4019,7 +4019,7 @@ "type": "array" }, "databaseReplicationEnabled": { - "description": "Configuration specific to read replica instances. Indicates whether replication is enabled or not.", + "description": "Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.", "type": "boolean" }, "denyMaintenancePeriods": { @@ -4100,7 +4100,7 @@ "type": "string" }, "tier": { - "description": "The tier (or machine type) for this instance, for example **db-custom-1-3840**.", + "description": "The tier (or machine type) for this instance, for example **db-custom-1-3840**. WARNING: Changing this restarts the instance.", "type": "string" }, "userLabels": { diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 7671f2edd47..278a08ce617 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": "\"3137363332383633313735343831303635323033\"", + "etag": "\"3138343334363134373734353330323437343338\"", "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": "20211201", + "revision": "20211209", "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 81c55dfb464..814648b8175 100644 --- a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json @@ -600,7 +600,7 @@ } } }, - "revision": "20211202", + "revision": "20211217", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -705,7 +705,7 @@ "id": "AzureCredentials", "properties": { "sasToken": { - "description": "Required. Azure shared access signature (SAS). *Note:*Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-stages). During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).", + "description": "Required. Azure shared access signature (SAS). For more information about SAS, see [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).", "type": "string" } }, @@ -932,15 +932,15 @@ "type": "object" }, "LoggingConfig": { - "description": "Logging configuration.", + "description": "Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details.", "id": "LoggingConfig", "properties": { "enableOnpremGcsTransferLogs": { - "description": "Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer.", + "description": "For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.", "type": "boolean" }, "logActionStates": { - "description": "States in which `log_actions` are logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources.", + "description": "States in which `log_actions` are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.", "items": { "enum": [ "LOGGABLE_ACTION_STATE_UNSPECIFIED", @@ -949,15 +949,15 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "`LoggableAction` is completed successfully. `SUCCEEDED` actions are logged as INFO.", - "`LoggableAction` is terminated in an error state. `FAILED` actions are logged as ERROR." + "`LoggableAction` completed successfully. `SUCCEEDED` actions are logged as INFO.", + "`LoggableAction` terminated in an error state. `FAILED` actions are logged as ERROR." ], "type": "string" }, "type": "array" }, "logActions": { - "description": "Actions to be logged. If empty, no logs are generated. This is not yet supported for transfers with PosixFilesystem data sources.", + "description": "Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.", "items": { "enum": [ "LOGGABLE_ACTION_UNSPECIFIED", @@ -967,9 +967,9 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "Finding objects to transfer e.g. listing objects of the source bucket.", - "Deleting objects at source or destination.", - "Copying objects from source to destination." + "Listing objects in a bucket.", + "Deleting objects at the source or the destination.", + "Copying objects to Google Cloud Storage." ], "type": "string" }, @@ -978,6 +978,69 @@ }, "type": "object" }, + "MetadataOptions": { + "description": "Specifies the metadata options for running a transfer.", + "id": "MetadataOptions", + "properties": { + "gid": { + "description": "Specifies how each file's GID attribute should be handled by the transfer. If unspecified, the default behavior is the same as GID_SKIP when the source is a POSIX file system.", + "enum": [ + "GID_UNSPECIFIED", + "GID_SKIP", + "GID_NUMBER" + ], + "enumDescriptions": [ + "GID behavior is unspecified.", + "Skip GID during a transfer job.", + "Preserve GID during a transfer job." + ], + "type": "string" + }, + "mode": { + "description": "Specifies how each file's mode attribute should be handled by the transfer. If unspecified, the default behavior is the same as MODE_SKIP when the source is a POSIX file system.", + "enum": [ + "MODE_UNSPECIFIED", + "MODE_SKIP", + "MODE_PRESERVE" + ], + "enumDescriptions": [ + "Mode behavior is unspecified.", + "Skip mode during a transfer job.", + "Preserve mode during a transfer job." + ], + "type": "string" + }, + "symlink": { + "description": "Specifies how symlinks should be handled by the transfer. If unspecified, the default behavior is the same as SYMLINK_SKIP when the source is a POSIX file system.", + "enum": [ + "SYMLINK_UNSPECIFIED", + "SYMLINK_SKIP", + "SYMLINK_PRESERVE" + ], + "enumDescriptions": [ + "Symlink behavior is unspecified. The default behavior is to skip symlinks during a transfer job.", + "Skip symlinks during a transfer job.", + "Preserve symlinks during a transfer job." + ], + "type": "string" + }, + "uid": { + "description": "Specifies how each file's UID attribute should be handled by the transfer. If unspecified, the default behavior is the same as UID_SKIP when the source is a POSIX file system.", + "enum": [ + "UID_UNSPECIFIED", + "UID_SKIP", + "UID_NUMBER" + ], + "enumDescriptions": [ + "UID behavior is unspecified.", + "Skip UID during a transfer job.", + "Preserve UID during a transfer job." + ], + "type": "string" + } + }, + "type": "object" + }, "NotificationConfig": { "description": "Specification to configure notifications published to Pub/Sub. Notifications are 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` contains a TransferOperation resource formatted according to the specified `PayloadFormat`.", "id": "NotificationConfig", @@ -1492,6 +1555,10 @@ "description": "Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive.", "type": "boolean" }, + "metadataOptions": { + "$ref": "MetadataOptions", + "description": "Represents the selected metadata options for a transfer job." + }, "overwriteObjectsAlreadyExistingInSink": { "description": "When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.", "type": "boolean" @@ -1519,6 +1586,10 @@ "$ref": "GcsData", "description": "A Cloud Storage data source." }, + "gcsIntermediateDataLocation": { + "$ref": "GcsData", + "description": "Cloud Storage intermediate data location." + }, "httpDataSource": { "$ref": "HttpData", "description": "An HTTP URL data source." @@ -1564,10 +1635,10 @@ }, "transferJob": { "$ref": "TransferJob", - "description": "Required. The job to update. `transferJob` is expected to specify only four fields: description, transfer_spec, notification_config, and status. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires `storagetransfer.jobs.delete` permissions." + "description": "Required. The job to update. `transferJob` is expected to specify one or more of five fields: description, transfer_spec, notification_config, [logging_config[TransferJob.logging_config], and status. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires `storagetransfer.jobs.delete` permissions." }, "updateTransferJobFieldMask": { - "description": "The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: description, transfer_spec, notification_config, and status. To update the `transfer_spec` of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.", + "description": "The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update the `transfer_spec` of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.", "format": "google-fieldmask", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index 40423c63ed9..aacb74ab509 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -375,7 +375,7 @@ } } }, - "revision": "20211204", + "revision": "20211213", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index b043a91d858..74faa0ce504 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -131,7 +131,7 @@ } } }, - "revision": "20211105", + "revision": "20211203", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1beta.json b/googleapiclient/discovery_cache/documents/sts.v1beta.json index 35bcda6a485..5b612b28906 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -116,7 +116,7 @@ } } }, - "revision": "20211105", + "revision": "20211203", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index c73825e2790..0c58fd7e3c4 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20211130", + "revision": "20211216", "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 33efeb5cd0d..1bb810913d3 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3317,7 +3317,7 @@ } } }, - "revision": "20211130", + "revision": "20211216", "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 dac084eeadf..cf2eb3582ae 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20211130", + "revision": "20211220", "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 8b61ddaa970..120001c8db8 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -282,7 +282,7 @@ } } }, - "revision": "20211123", + "revision": "20211228", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -572,16 +572,6 @@ "description": "The java package for the application under test. The default value is determined by examining the application's manifest.", "type": "string" }, - "maxDepth": { - "description": "The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50.", - "format": "int32", - "type": "integer" - }, - "maxSteps": { - "description": "The max number of steps Robo can execute. Default is no limit.", - "format": "int32", - "type": "integer" - }, "roboDirectives": { "description": "A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided.", "items": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index cf152f1a0ae..8fa027a9728 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20211130", + "revision": "20211203", "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 b9d24632cda..921f6206528 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20211130", + "revision": "20211203", "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 6dbe8ce76c7..3b6318836fb 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, - "revision": "20211203", + "revision": "20211208", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json index 1d010f06c2d..5998ecc1c60 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20211112", + "revision": "20211130", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/transcoder.v1.json b/googleapiclient/discovery_cache/documents/transcoder.v1.json new file mode 100644 index 00000000000..f0650dbede0 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/transcoder.v1.json @@ -0,0 +1,1555 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://transcoder.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Transcoder", + "description": "This API converts video files into formats suitable for consumer distribution. ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/transcoder/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": "transcoder:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://transcoder.mtls.googleapis.com/", + "name": "transcoder", + "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": { + "resources": { + "jobTemplates": { + "methods": { + "create": { + "description": "Creates a job template in the specified region.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates", + "httpMethod": "POST", + "id": "transcoder.projects.locations.jobTemplates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "jobTemplateId": { + "description": "Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression `a-zA-Z*`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/jobTemplates", + "request": { + "$ref": "JobTemplate" + }, + "response": { + "$ref": "JobTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a job template.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}", + "httpMethod": "DELETE", + "id": "transcoder.projects.locations.jobTemplates.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the job template is not found, the request will succeed but no action will be taken on the server.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the job template data.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobTemplates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "JobTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists job templates in the specified region.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobTemplates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression, following the syntax outlined in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The `next_page_token` value returned from a previous List request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/jobTemplates", + "response": { + "$ref": "ListJobTemplatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "jobs": { + "methods": { + "create": { + "description": "Creates a job in the specified region.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs", + "httpMethod": "POST", + "id": "transcoder.projects.locations.jobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/jobs", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", + "httpMethod": "DELETE", + "id": "transcoder.projects.locations.jobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the job is not found, the request will succeed but no action will be taken on the server.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the job data.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists jobs in the specified region.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression, following the syntax outlined in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The `next_page_token` value returned from a previous List request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/jobs", + "response": { + "$ref": "ListJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20211108", + "rootUrl": "https://transcoder.googleapis.com/", + "schemas": { + "AdBreak": { + "description": "Ad break.", + "id": "AdBreak", + "properties": { + "startTimeOffset": { + "description": "Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "Animation": { + "description": "Animation types.", + "id": "Animation", + "properties": { + "animationEnd": { + "$ref": "AnimationEnd", + "description": "End previous animation." + }, + "animationFade": { + "$ref": "AnimationFade", + "description": "Display overlay object with fade animation." + }, + "animationStatic": { + "$ref": "AnimationStatic", + "description": "Display static overlay object." + } + }, + "type": "object" + }, + "AnimationEnd": { + "description": "End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video.", + "id": "AnimationEnd", + "properties": { + "startTimeOffset": { + "description": "The time to end overlay object, in seconds. Default: 0", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "AnimationFade": { + "description": "Display overlay object with fade animation.", + "id": "AnimationFade", + "properties": { + "endTimeOffset": { + "description": "The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s", + "format": "google-duration", + "type": "string" + }, + "fadeType": { + "description": "Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.", + "enum": [ + "FADE_TYPE_UNSPECIFIED", + "FADE_IN", + "FADE_OUT" + ], + "enumDescriptions": [ + "The fade type is not specified.", + "Fade the overlay object into view.", + "Fade the overlay object out of view." + ], + "type": "string" + }, + "startTimeOffset": { + "description": "The time to start the fade animation, in seconds. Default: 0", + "format": "google-duration", + "type": "string" + }, + "xy": { + "$ref": "NormalizedCoordinate", + "description": "Normalized coordinates based on output video resolution. Valid values: `0.0`\u2013`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video." + } + }, + "type": "object" + }, + "AnimationStatic": { + "description": "Display static overlay object.", + "id": "AnimationStatic", + "properties": { + "startTimeOffset": { + "description": "The time to start displaying the overlay object, in seconds. Default: 0", + "format": "google-duration", + "type": "string" + }, + "xy": { + "$ref": "NormalizedCoordinate", + "description": "Normalized coordinates based on output video resolution. Valid values: `0.0`\u2013`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video." + } + }, + "type": "object" + }, + "Audio": { + "description": "Audio preprocessing configuration.", + "id": "Audio", + "properties": { + "highBoost": { + "description": "Enable boosting high frequency components. The default is `false`.", + "type": "boolean" + }, + "lowBoost": { + "description": "Enable boosting low frequency components. The default is `false`.", + "type": "boolean" + }, + "lufs": { + "description": "Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "AudioMapping": { + "description": "The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.", + "id": "AudioMapping", + "properties": { + "atomKey": { + "description": "Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.", + "type": "string" + }, + "gainDb": { + "description": "Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.", + "format": "double", + "type": "number" + }, + "inputChannel": { + "description": "Required. The zero-based index of the channel in the input audio stream.", + "format": "int32", + "type": "integer" + }, + "inputKey": { + "description": "Required. The `Input.key` that identifies the input file.", + "type": "string" + }, + "inputTrack": { + "description": "Required. The zero-based index of the track in the input file.", + "format": "int32", + "type": "integer" + }, + "outputChannel": { + "description": "Required. The zero-based index of the channel in the output audio stream.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AudioStream": { + "description": "Audio stream resource.", + "id": "AudioStream", + "properties": { + "bitrateBps": { + "description": "Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.", + "format": "int32", + "type": "integer" + }, + "channelCount": { + "description": "Number of audio channels. Must be between 1 and 6. The default is 2.", + "format": "int32", + "type": "integer" + }, + "channelLayout": { + "description": "A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `[\"fl\", \"fr\"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency", + "items": { + "type": "string" + }, + "type": "array" + }, + "codec": { + "description": "The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`", + "type": "string" + }, + "mapping": { + "description": "The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.", + "items": { + "$ref": "AudioMapping" + }, + "type": "array" + }, + "sampleRateHertz": { + "description": "The audio sample rate in Hertz. The default is 48000 Hertz.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Color": { + "description": "Color preprocessing configuration.", + "id": "Color", + "properties": { + "brightness": { + "description": "Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.", + "format": "double", + "type": "number" + }, + "contrast": { + "description": "Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.", + "format": "double", + "type": "number" + }, + "saturation": { + "description": "Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Crop": { + "description": "Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.", + "id": "Crop", + "properties": { + "bottomPixels": { + "description": "The number of pixels to crop from the bottom. The default is 0.", + "format": "int32", + "type": "integer" + }, + "leftPixels": { + "description": "The number of pixels to crop from the left. The default is 0.", + "format": "int32", + "type": "integer" + }, + "rightPixels": { + "description": "The number of pixels to crop from the right. The default is 0.", + "format": "int32", + "type": "integer" + }, + "topPixels": { + "description": "The number of pixels to crop from the top. The default is 0.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Deblock": { + "description": "Deblock preprocessing configuration.", + "id": "Deblock", + "properties": { + "enabled": { + "description": "Enable deblocker. The default is `false`.", + "type": "boolean" + }, + "strength": { + "description": "Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Denoise": { + "description": "Denoise preprocessing configuration.", + "id": "Denoise", + "properties": { + "strength": { + "description": "Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.", + "format": "double", + "type": "number" + }, + "tune": { + "description": "Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`", + "type": "string" + } + }, + "type": "object" + }, + "EditAtom": { + "description": "Edit atom.", + "id": "EditAtom", + "properties": { + "endTimeOffset": { + "description": "End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.", + "format": "google-duration", + "type": "string" + }, + "inputs": { + "description": "List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.", + "items": { + "type": "string" + }, + "type": "array" + }, + "key": { + "description": "A unique key for this atom. Must be specified when using advanced mapping.", + "type": "string" + }, + "startTimeOffset": { + "description": "Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "ElementaryStream": { + "description": "Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.", + "id": "ElementaryStream", + "properties": { + "audioStream": { + "$ref": "AudioStream", + "description": "Encoding of an audio stream." + }, + "key": { + "description": "A unique key for this elementary stream.", + "type": "string" + }, + "textStream": { + "$ref": "TextStream", + "description": "Encoding of a text stream. For example, closed captions or subtitles." + }, + "videoStream": { + "$ref": "VideoStream", + "description": "Encoding of a video stream." + } + }, + "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" + }, + "H264CodecSettings": { + "description": "H264 codec settings.", + "id": "H264CodecSettings", + "properties": { + "allowOpenGop": { + "description": "Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.", + "type": "boolean" + }, + "aqStrength": { + "description": "Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.", + "format": "double", + "type": "number" + }, + "bFrameCount": { + "description": "The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.", + "format": "int32", + "type": "integer" + }, + "bPyramid": { + "description": "Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.", + "type": "boolean" + }, + "bitrateBps": { + "description": "Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.", + "format": "int32", + "type": "integer" + }, + "crfLevel": { + "description": "Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.", + "format": "int32", + "type": "integer" + }, + "enableTwoPass": { + "description": "Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.", + "type": "boolean" + }, + "entropyCoder": { + "description": "The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`", + "type": "string" + }, + "frameRate": { + "description": "Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.", + "format": "double", + "type": "number" + }, + "gopDuration": { + "description": "Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.", + "format": "google-duration", + "type": "string" + }, + "gopFrameCount": { + "description": "Select the GOP size based on the specified frame count. Must be greater than zero.", + "format": "int32", + "type": "integer" + }, + "heightPixels": { + "description": "The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.", + "format": "int32", + "type": "integer" + }, + "pixelFormat": { + "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format", + "type": "string" + }, + "preset": { + "description": "Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.", + "type": "string" + }, + "profile": { + "description": "Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.", + "type": "string" + }, + "rateControlMode": { + "description": "Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor", + "type": "string" + }, + "tune": { + "description": "Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.", + "type": "string" + }, + "vbvFullnessBits": { + "description": "Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.", + "format": "int32", + "type": "integer" + }, + "vbvSizeBits": { + "description": "Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.", + "format": "int32", + "type": "integer" + }, + "widthPixels": { + "description": "The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "H265CodecSettings": { + "description": "H265 codec settings.", + "id": "H265CodecSettings", + "properties": { + "allowOpenGop": { + "description": "Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.", + "type": "boolean" + }, + "aqStrength": { + "description": "Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.", + "format": "double", + "type": "number" + }, + "bFrameCount": { + "description": "The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.", + "format": "int32", + "type": "integer" + }, + "bPyramid": { + "description": "Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.", + "type": "boolean" + }, + "bitrateBps": { + "description": "Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.", + "format": "int32", + "type": "integer" + }, + "crfLevel": { + "description": "Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.", + "format": "int32", + "type": "integer" + }, + "enableTwoPass": { + "description": "Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.", + "type": "boolean" + }, + "frameRate": { + "description": "Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.", + "format": "double", + "type": "number" + }, + "gopDuration": { + "description": "Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.", + "format": "google-duration", + "type": "string" + }, + "gopFrameCount": { + "description": "Select the GOP size based on the specified frame count. Must be greater than zero.", + "format": "int32", + "type": "integer" + }, + "heightPixels": { + "description": "The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.", + "format": "int32", + "type": "integer" + }, + "pixelFormat": { + "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format", + "type": "string" + }, + "preset": { + "description": "Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.", + "type": "string" + }, + "profile": { + "description": "Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.", + "type": "string" + }, + "rateControlMode": { + "description": "Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor", + "type": "string" + }, + "tune": { + "description": "Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.", + "type": "string" + }, + "vbvFullnessBits": { + "description": "Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.", + "format": "int32", + "type": "integer" + }, + "vbvSizeBits": { + "description": "Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.", + "format": "int32", + "type": "integer" + }, + "widthPixels": { + "description": "The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Image": { + "description": "Overlaid jpeg image.", + "id": "Image", + "properties": { + "alpha": { + "description": "Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.", + "format": "double", + "type": "number" + }, + "resolution": { + "$ref": "NormalizedCoordinate", + "description": "Normalized image resolution, based on output video resolution. Valid values: `0.0`\u2013`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`." + }, + "uri": { + "description": "Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.", + "type": "string" + } + }, + "type": "object" + }, + "Input": { + "description": "Input asset.", + "id": "Input", + "properties": { + "key": { + "description": "A unique key for this input. Must be specified when using advanced mapping and edit lists.", + "type": "string" + }, + "preprocessingConfig": { + "$ref": "PreprocessingConfig", + "description": "Preprocessing configurations." + }, + "uri": { + "description": "URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.", + "type": "string" + } + }, + "type": "object" + }, + "Job": { + "description": "Transcoding job resource.", + "id": "Job", + "properties": { + "config": { + "$ref": "JobConfig", + "description": "The configuration for this job." + }, + "createTime": { + "description": "Output only. The time the job was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the transcoding finished.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. An error object that describes the reason for the failure. This property is always present when `state` is `FAILED`.", + "readOnly": true + }, + "inputUri": { + "description": "Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).", + "type": "string" + }, + "name": { + "description": "The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}`", + "type": "string" + }, + "outputUri": { + "description": "Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.", + "type": "string" + }, + "startTime": { + "description": "Output only. The time the transcoding started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the job.", + "enum": [ + "PROCESSING_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The processing state is not specified.", + "The job is enqueued and will be picked up for processing soon.", + "The job is being processed.", + "The job has been completed successfully.", + "The job has failed. For additional information, see `failure_reason` and `failure_details`" + ], + "readOnly": true, + "type": "string" + }, + "templateId": { + "description": "Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`", + "type": "string" + }, + "ttlAfterCompletionDays": { + "description": "Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "JobConfig": { + "description": "Job configuration", + "id": "JobConfig", + "properties": { + "adBreaks": { + "description": "List of ad breaks. Specifies where to insert ad break tags in the output manifests.", + "items": { + "$ref": "AdBreak" + }, + "type": "array" + }, + "editList": { + "description": "List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.", + "items": { + "$ref": "EditAtom" + }, + "type": "array" + }, + "elementaryStreams": { + "description": "List of elementary streams.", + "items": { + "$ref": "ElementaryStream" + }, + "type": "array" + }, + "inputs": { + "description": "List of input assets stored in Cloud Storage.", + "items": { + "$ref": "Input" + }, + "type": "array" + }, + "manifests": { + "description": "List of output manifests.", + "items": { + "$ref": "Manifest" + }, + "type": "array" + }, + "muxStreams": { + "description": "List of multiplexing settings for output streams.", + "items": { + "$ref": "MuxStream" + }, + "type": "array" + }, + "output": { + "$ref": "Output", + "description": "Output configuration." + }, + "overlays": { + "description": "List of overlays on the output video, in descending Z-order.", + "items": { + "$ref": "Overlay" + }, + "type": "array" + }, + "pubsubDestination": { + "$ref": "PubsubDestination", + "description": "Destination on Pub/Sub." + }, + "spriteSheets": { + "description": "List of output sprite sheets.", + "items": { + "$ref": "SpriteSheet" + }, + "type": "array" + } + }, + "type": "object" + }, + "JobTemplate": { + "description": "Transcoding job template resource.", + "id": "JobTemplate", + "properties": { + "config": { + "$ref": "JobConfig", + "description": "The configuration for this template." + }, + "name": { + "description": "The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`", + "type": "string" + } + }, + "type": "object" + }, + "ListJobTemplatesResponse": { + "description": "Response message for `TranscoderService.ListJobTemplates`.", + "id": "ListJobTemplatesResponse", + "properties": { + "jobTemplates": { + "description": "List of job templates in the specified region.", + "items": { + "$ref": "JobTemplate" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The pagination token.", + "type": "string" + }, + "unreachable": { + "description": "List of regions that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListJobsResponse": { + "description": "Response message for `TranscoderService.ListJobs`.", + "id": "ListJobsResponse", + "properties": { + "jobs": { + "description": "List of jobs in the specified region.", + "items": { + "$ref": "Job" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The pagination token.", + "type": "string" + }, + "unreachable": { + "description": "List of regions that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Manifest": { + "description": "Manifest configuration.", + "id": "Manifest", + "properties": { + "fileName": { + "description": "The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.", + "type": "string" + }, + "muxStreams": { + "description": "Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "Required. Type of the manifest, can be `HLS` or `DASH`.", + "enum": [ + "MANIFEST_TYPE_UNSPECIFIED", + "HLS", + "DASH" + ], + "enumDescriptions": [ + "The manifest type is not specified.", + "Create `HLS` manifest. The corresponding file extension is `.m3u8`.", + "Create `DASH` manifest. The corresponding file extension is `.mpd`." + ], + "type": "string" + } + }, + "type": "object" + }, + "MuxStream": { + "description": "Multiplexing settings for output stream.", + "id": "MuxStream", + "properties": { + "container": { + "description": "The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt`", + "type": "string" + }, + "elementaryStreams": { + "description": "List of `ElementaryStream.key`s multiplexed in this stream.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fileName": { + "description": "The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.", + "type": "string" + }, + "key": { + "description": "A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.", + "type": "string" + }, + "segmentSettings": { + "$ref": "SegmentSettings", + "description": "Segment settings for `ts`, `fmp4` and `vtt`." + } + }, + "type": "object" + }, + "NormalizedCoordinate": { + "description": "2D normalized coordinates. Default: `{0.0, 0.0}`", + "id": "NormalizedCoordinate", + "properties": { + "x": { + "description": "Normalized x coordinate.", + "format": "double", + "type": "number" + }, + "y": { + "description": "Normalized y coordinate.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Output": { + "description": "Location of output file(s) in a Cloud Storage bucket.", + "id": "Output", + "properties": { + "uri": { + "description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.", + "type": "string" + } + }, + "type": "object" + }, + "Overlay": { + "description": "Overlay configuration.", + "id": "Overlay", + "properties": { + "animations": { + "description": "List of Animations. The list should be chronological, without any time overlap.", + "items": { + "$ref": "Animation" + }, + "type": "array" + }, + "image": { + "$ref": "Image", + "description": "Image overlay." + } + }, + "type": "object" + }, + "Pad": { + "description": "Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.", + "id": "Pad", + "properties": { + "bottomPixels": { + "description": "The number of pixels to add to the bottom. The default is 0.", + "format": "int32", + "type": "integer" + }, + "leftPixels": { + "description": "The number of pixels to add to the left. The default is 0.", + "format": "int32", + "type": "integer" + }, + "rightPixels": { + "description": "The number of pixels to add to the right. The default is 0.", + "format": "int32", + "type": "integer" + }, + "topPixels": { + "description": "The number of pixels to add to the top. The default is 0.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PreprocessingConfig": { + "description": "Preprocessing configurations.", + "id": "PreprocessingConfig", + "properties": { + "audio": { + "$ref": "Audio", + "description": "Audio preprocessing configuration." + }, + "color": { + "$ref": "Color", + "description": "Color preprocessing configuration." + }, + "crop": { + "$ref": "Crop", + "description": "Specify the video cropping configuration." + }, + "deblock": { + "$ref": "Deblock", + "description": "Deblock preprocessing configuration." + }, + "denoise": { + "$ref": "Denoise", + "description": "Denoise preprocessing configuration." + }, + "pad": { + "$ref": "Pad", + "description": "Specify the video pad filter configuration." + } + }, + "type": "object" + }, + "PubsubDestination": { + "description": "A Pub/Sub destination.", + "id": "PubsubDestination", + "properties": { + "topic": { + "description": "The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.", + "type": "string" + } + }, + "type": "object" + }, + "SegmentSettings": { + "description": "Segment settings for `ts`, `fmp4` and `vtt`.", + "id": "SegmentSettings", + "properties": { + "individualSegments": { + "description": "Required. Create an individual segment file. The default is `false`.", + "type": "boolean" + }, + "segmentDuration": { + "description": "Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "SpriteSheet": { + "description": "Sprite sheet configuration.", + "id": "SpriteSheet", + "properties": { + "columnCount": { + "description": "The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.", + "format": "int32", + "type": "integer" + }, + "endTimeOffset": { + "description": "End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.", + "format": "google-duration", + "type": "string" + }, + "filePrefix": { + "description": "Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.", + "type": "string" + }, + "format": { + "description": "Format type. The default is `jpeg`. Supported formats: - `jpeg`", + "type": "string" + }, + "interval": { + "description": "Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.", + "format": "google-duration", + "type": "string" + }, + "quality": { + "description": "The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.", + "format": "int32", + "type": "integer" + }, + "rowCount": { + "description": "The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.", + "format": "int32", + "type": "integer" + }, + "spriteHeightPixels": { + "description": "Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).", + "format": "int32", + "type": "integer" + }, + "spriteWidthPixels": { + "description": "Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).", + "format": "int32", + "type": "integer" + }, + "startTimeOffset": { + "description": "Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.", + "format": "google-duration", + "type": "string" + }, + "totalCount": { + "description": "Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.", + "format": "int32", + "type": "integer" + } + }, + "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" + }, + "TextMapping": { + "description": "The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.", + "id": "TextMapping", + "properties": { + "atomKey": { + "description": "Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.", + "type": "string" + }, + "inputKey": { + "description": "Required. The `Input.key` that identifies the input file.", + "type": "string" + }, + "inputTrack": { + "description": "Required. The zero-based index of the track in the input file.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TextStream": { + "description": "Encoding of a text stream. For example, closed captions or subtitles.", + "id": "TextStream", + "properties": { + "codec": { + "description": "The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`", + "type": "string" + }, + "mapping": { + "description": "The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.", + "items": { + "$ref": "TextMapping" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoStream": { + "description": "Video stream resource.", + "id": "VideoStream", + "properties": { + "h264": { + "$ref": "H264CodecSettings", + "description": "H264 codec settings." + }, + "h265": { + "$ref": "H265CodecSettings", + "description": "H265 codec settings." + }, + "vp9": { + "$ref": "Vp9CodecSettings", + "description": "VP9 codec settings." + } + }, + "type": "object" + }, + "Vp9CodecSettings": { + "description": "VP9 codec settings.", + "id": "Vp9CodecSettings", + "properties": { + "bitrateBps": { + "description": "Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.", + "format": "int32", + "type": "integer" + }, + "crfLevel": { + "description": "Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.", + "format": "int32", + "type": "integer" + }, + "frameRate": { + "description": "Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculating frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.", + "format": "double", + "type": "number" + }, + "gopDuration": { + "description": "Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.", + "format": "google-duration", + "type": "string" + }, + "gopFrameCount": { + "description": "Select the GOP size based on the specified frame count. Must be greater than zero.", + "format": "int32", + "type": "integer" + }, + "heightPixels": { + "description": "The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.", + "format": "int32", + "type": "integer" + }, + "pixelFormat": { + "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format", + "type": "string" + }, + "profile": { + "description": "Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.", + "type": "string" + }, + "rateControlMode": { + "description": "Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor", + "type": "string" + }, + "widthPixels": { + "description": "The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Transcoder API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/translate.v3.json b/googleapiclient/discovery_cache/documents/translate.v3.json index fa676be4ed5..54ff2568b70 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3.json +++ b/googleapiclient/discovery_cache/documents/translate.v3.json @@ -744,7 +744,7 @@ } } }, - "revision": "20211203", + "revision": "20211220", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { diff --git a/googleapiclient/discovery_cache/documents/translate.v3beta1.json b/googleapiclient/discovery_cache/documents/translate.v3beta1.json index 286735e4075..0c9b7f4a59c 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/translate.v3beta1.json @@ -744,7 +744,7 @@ } } }, - "revision": "20211203", + "revision": "20211220", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { diff --git a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json index a8094358d6b..753632df22c 100644 --- a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +++ b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20210630", + "revision": "20211203", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { diff --git a/googleapiclient/discovery_cache/documents/versionhistory.v1.json b/googleapiclient/discovery_cache/documents/versionhistory.v1.json index 1d6c6fa427b..8238eef3f55 100644 --- a/googleapiclient/discovery_cache/documents/versionhistory.v1.json +++ b/googleapiclient/discovery_cache/documents/versionhistory.v1.json @@ -271,7 +271,7 @@ } } }, - "revision": "20211206", + "revision": "20211220", "rootUrl": "https://versionhistory.googleapis.com/", "schemas": { "Channel": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1.json index d7086e36eba..0679ebc95be 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1.json @@ -350,7 +350,7 @@ } } }, - "revision": "20211126", + "revision": "20211210", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json index cdfe5e3eecf..c328c29a320 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20211126", + "revision": "20211210", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json index 1450b39f4e1..ac1397617d2 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20211126", + "revision": "20211210", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json index 7ea5ad71fcf..822ccd6bd15 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20211126", + "revision": "20211210", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json index d931e421aab..18b1c714fb5 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20211126", + "revision": "20211210", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1.json b/googleapiclient/discovery_cache/documents/vision.v1.json index 6f964d2b10b..7a98736f78f 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1.json @@ -1282,7 +1282,7 @@ } } }, - "revision": "20211112", + "revision": "20211210", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json index d91551388b5..51ea16b1e27 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20211112", + "revision": "20211210", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json index 02faf8874f8..4d638c89d63 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20211112", + "revision": "20211210", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index f7d7d3c2fcd..db2d3b13b71 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -1858,7 +1858,7 @@ } } }, - "revision": "20211130", + "revision": "20211229", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AddGroupMigrationRequest": { @@ -1997,6 +1997,13 @@ "description": "ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDefaults", "properties": { + "additionalLicenses": { + "description": "Additional licenses to assign to the VM.", + "items": { + "type": "string" + }, + "type": "array" + }, "appliedLicense": { "$ref": "AppliedLicense", "description": "Output only. The OS license returned from the adaptation module report.", @@ -2114,6 +2121,13 @@ "description": "ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDetails", "properties": { + "additionalLicenses": { + "description": "Additional licenses to assign to the VM.", + "items": { + "type": "string" + }, + "type": "array" + }, "appliedLicense": { "$ref": "AppliedLicense", "description": "The OS license returned from the adaptation module report." diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index af324bcd051..e2c9f5766f4 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -1858,7 +1858,7 @@ } } }, - "revision": "20211130", + "revision": "20211207", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AddGroupMigrationRequest": { @@ -1989,6 +1989,13 @@ "description": "ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDefaults", "properties": { + "additionalLicenses": { + "description": "Additional licenses to assign to the VM.", + "items": { + "type": "string" + }, + "type": "array" + }, "appliedLicense": { "$ref": "AppliedLicense", "description": "Output only. The OS license returned from the adaptation module report.", @@ -2106,6 +2113,13 @@ "description": "ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project.", "id": "ComputeEngineTargetDetails", "properties": { + "additionalLicenses": { + "description": "Additional licenses to assign to the VM.", + "items": { + "type": "string" + }, + "type": "array" + }, "appliedLicense": { "$ref": "AppliedLicense", "description": "The OS license returned from the adaptation module report." diff --git a/googleapiclient/discovery_cache/documents/webfonts.v1.json b/googleapiclient/discovery_cache/documents/webfonts.v1.json index 77b18a7edd7..37ab491afca 100644 --- a/googleapiclient/discovery_cache/documents/webfonts.v1.json +++ b/googleapiclient/discovery_cache/documents/webfonts.v1.json @@ -134,7 +134,7 @@ } } }, - "revision": "20211105", + "revision": "20211213", "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 b4ee1dd8907..3bec1b1c536 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -446,7 +446,7 @@ } } }, - "revision": "20211203", + "revision": "20211230", "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 80f5248a3f3..b59f4a9596f 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json @@ -526,7 +526,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json index 10ba07e42d7..9227083811b 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json @@ -526,7 +526,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "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 64103db8597..a8cf2b9a5c4 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json @@ -526,7 +526,7 @@ } } }, - "revision": "20211203", + "revision": "20211211", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index 3fa3fb60db5..af18d67447c 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -269,7 +269,7 @@ } } }, - "revision": "20211123", + "revision": "20211130", "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 995125eaf0c..bee3a880737 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json @@ -269,7 +269,7 @@ } } }, - "revision": "20211123", + "revision": "20211130", "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 5042e6a56db..a9d5ee09d50 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -444,7 +444,7 @@ } } }, - "revision": "20211117", + "revision": "20211201", "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 8b98911fb6e..296df3f1e7c 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json @@ -444,7 +444,7 @@ } } }, - "revision": "20211117", + "revision": "20211201", "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 39c890bd59a..d7ef235c55b 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -3789,7 +3789,7 @@ } } }, - "revision": "20211204", + "revision": "20220103", "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 87c0487aff2..77ca593d645 100644 --- a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +++ b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json @@ -421,7 +421,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "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 73102acb229..a9ee25b7c91 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20211203", + "revision": "20220103", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/model.py b/googleapiclient/model.py index b023db4dd2d..3d1f397692f 100644 --- a/googleapiclient/model.py +++ b/googleapiclient/model.py @@ -26,12 +26,12 @@ import json import logging import platform -import pkg_resources import urllib +from googleapiclient import version as googleapiclient_version from googleapiclient.errors import HttpError -_LIBRARY_VERSION = pkg_resources.get_distribution("google-api-python-client").version +_LIBRARY_VERSION = googleapiclient_version.__version__ _PY_VERSION = platform.python_version() LOGGER = logging.getLogger(__name__) diff --git a/googleapiclient/version.py b/googleapiclient/version.py new file mode 100644 index 00000000000..b9008a8f82b --- /dev/null +++ b/googleapiclient/version.py @@ -0,0 +1,15 @@ +# 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. + +__version__ = "2.34.0" diff --git a/owlbot.py b/owlbot.py index 0d995c19fea..4a03f4bdd92 100644 --- a/owlbot.py +++ b/owlbot.py @@ -35,6 +35,9 @@ # Move scripts folder needed for samples CI s.move(templated_files / 'scripts') +# Copy CONTRIBUTING.rst +s.move(templated_files / 'CONTRIBUTING.rst') + # ---------------------------------------------------------------------------- # Samples templates # ---------------------------------------------------------------------------- diff --git a/samples/compute/requirements.txt b/samples/compute/requirements.txt index 83ea01b003d..56e7e8e2dc2 100644 --- a/samples/compute/requirements.txt +++ b/samples/compute/requirements.txt @@ -1,3 +1,3 @@ -google-api-python-client==2.32.0 +google-api-python-client==2.33.0 google-auth==2.3.3 google-auth-httplib2==0.1.0 diff --git a/scripts/requirements.txt b/scripts/requirements.txt index d3bddebad17..416be5ae7dd 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1 +1 @@ -pandas==1.3.4 +pandas==1.3.5 diff --git a/setup.py b/setup.py index ed8fa9bc9a7..344ba624a40 100644 --- a/setup.py +++ b/setup.py @@ -42,7 +42,7 @@ # Until this issue is closed # https://github.com/googleapis/google-cloud-python/issues/10566 "google-api-core>=1.21.0,<3.0.0dev", - "uritemplate>=3.0.0,<5", + "uritemplate>=3.0.1,<5", ] package_root = os.path.abspath(os.path.dirname(__file__)) @@ -51,7 +51,12 @@ with io.open(readme_filename, encoding="utf-8") as readme_file: readme = readme_file.read() -version = "2.33.0" +package_root = os.path.abspath(os.path.dirname(__file__)) + +version = {} +with open(os.path.join(package_root, "googleapiclient/version.py")) as fp: + exec(fp.read(), version) +version = version["__version__"] setup( name="google-api-python-client", diff --git a/testing/constraints-3.6.txt b/testing/constraints-3.6.txt index 0c0e7a2e53b..35fb5748093 100644 --- a/testing/constraints-3.6.txt +++ b/testing/constraints-3.6.txt @@ -9,4 +9,4 @@ httplib2==0.15.0 google-auth==1.16.0 google-auth-httplib2==0.0.3 google-api-core==1.21.0 -uritemplate==3.0.0 \ No newline at end of file +uritemplate==3.0.1 \ No newline at end of file diff --git a/tests/test_json_model.py b/tests/test_json_model.py index 322a7b4848c..533361c36e5 100644 --- a/tests/test_json_model.py +++ b/tests/test_json_model.py @@ -25,17 +25,17 @@ import io import httplib2 import json -import pkg_resources import platform import unittest import urllib import googleapiclient.model +from googleapiclient import version as googleapiclient_version from googleapiclient.errors import HttpError from googleapiclient.model import JsonModel -_LIBRARY_VERSION = pkg_resources.get_distribution("google-api-python-client").version +_LIBRARY_VERSION = googleapiclient_version.__version__ CSV_TEXT_MOCK = 'column1,column2,column3\nstring1,1.2,string2'